1. trait
  2. System
  3. \
  4. Traits
  5. \
  6. PropertyContainer

PropertyContainer

trait PropertyContainer

Properties

protected array $properties

Methods

array
validateProperties(array $properties)

Validates the properties against the defined properties of the class.

defineProperties()

Defines the properties used by this class.

setProperties(array $properties)

Sets multiple properties.

setProperty(string $name, mixed $value)

Sets a property value

array
getProperties()

Returns all properties.

mixed
property(string $name, string $default = null)

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

array
getPropertyOptions(string $property)

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

Details

at line 20
array validateProperties(array $properties)

Validates the properties against the defined properties of the class.

This method also sets default properties.

Parameters

array $properties

The supplied property values.

Return Value

array

The validated property set, with defaults applied.

at line 41
defineProperties()

Defines the properties used by this class.

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

at line 51
setProperties(array $properties)

Sets multiple properties.

Parameters

array $properties

at line 62
setProperty(string $name, mixed $value)

Sets a property value

Parameters

string $name
mixed $value

at line 71
array getProperties()

Returns all properties.

Return Value

array

at line 84
mixed property(string $name, string $default = null)

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

Parameters

string $name

The property name to look for.
string $default

A default value to return if no name is found.

Return Value

mixed

The property value or the default specified.

at line 98
array getPropertyOptions(string $property)

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

Parameters

string $property

Specifies the property name

Return Value

array

Return an array of option values and descriptions