1. Documentation
  2. API
  3. Backend
  4. Classes
  5. ReportWidgetBase

Backend\Classes\ReportWidgetBase

Overview

Report Widget base class Report widgets are used inside the ReportContainer.

Extends

Public Properties

There are no public properties in the class.

Show inherited public properties

Inherited Public Properties

Protected Properties

protected array $properties

properties contains the object property values.

Show inherited protected properties

Inherited Protected Properties

Public Methods

public __construct()

public __construct($controller, $properties = []): void

__construct the widget

public defineProperties()

public defineProperties(): void

defineProperties used by this class. This method should be used as an override in the extended class.

public getProperties()

public getProperties(): array

getProperties returns all properties.

public getPropertyOptions()

public getPropertyOptions(string $property): array

getPropertyOptions returns options for multi-option properties (drop-downs, etc.)

public property()

public property(string $name, ?string $default = null): ?string

property returns a defined property value or default if one is not set.

public setProperties()

public setProperties(array $properties): void

setProperties for multiple values

public setProperty()

public setProperty(string $name, mixed $value): void

setProperty for a single value

public validateProperties()

public validateProperties(array $properties): array

validateProperties against the defined properties of the class. This method also sets default properties.

Show inherited public methods

Inherited Public Methods

Protected Methods

Show inherited protected methods

Inherited Protected Methods