PropertyContainer
Property container trait
Adds properties and methods for classes that could define properties, like components or report widgets.
Tags
Table of Contents
- $properties : array<string|int, mixed>
- defineProperties() : mixed
- Defines the properties used by this class.
- getProperties() : array<string|int, mixed>
- Returns all properties.
- getPropertyOptions() : array<string|int, mixed>
- Returns options for multi-option properties (drop-downs, etc.)
- property() : string
- Returns a defined property value or default if one is not set.
- setProperties() : void
- Sets multiple properties.
- setProperty() : void
- Sets a property value
- validateProperties() : array<string|int, mixed>
- Validates the properties against the defined properties of the class.
Properties
$properties
protected
array<string|int, mixed>
$properties
= []
Contains the object property values.
Methods
defineProperties()
Defines the properties used by this class.
public
defineProperties() : mixed
This method should be used as an override in the extended class.
Return values
mixed —getProperties()
Returns all properties.
public
getProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPropertyOptions()
Returns options for multi-option properties (drop-downs, etc.)
public
getPropertyOptions(string $property) : array<string|int, mixed>
Parameters
- $property : string
-
Specifies the property name
Return values
array<string|int, mixed> —Return an array of option values and descriptions
property()
Returns a defined property value or default if one is not set.
public
property(string $name[, string $default = null ]) : string
Parameters
- $name : string
-
The property name to look for.
- $default : string = null
-
A default value to return if no name is found.
Return values
string —The property value or the default specified.
setProperties()
Sets multiple properties.
public
setProperties(array<string|int, mixed> $properties) : void
Parameters
- $properties : array<string|int, mixed>
Return values
void —setProperty()
Sets a property value
public
setProperty(string $name, mixed $value) : void
Parameters
- $name : string
- $value : mixed
Return values
void —validateProperties()
Validates the properties against the defined properties of the class.
public
validateProperties(array<string|int, mixed> $properties) : array<string|int, mixed>
This method also sets default properties.
Parameters
- $properties : array<string|int, mixed>
-
The supplied property values.
Return values
array<string|int, mixed> —The validated property set, with defaults applied.