CSR3PropertyDTOTrait

Set attribute

This method allow to set or add an attribute to the DTO

Get attribute

This method allow to retreive a value from a named attribute of the DTO

Set attributes

This method allow to set the attributes of the DTO from an associative array

Get attributes

This method return the attributes as array from the DTO

Offset exist

This method validate the existence of an offset

Offset get

This method return an offset value

Offset set

This method allow to set a value at an offset place

Offset unset

This method remove an offset

Current

This method return the current iterated value

Next

This method advance the internal pointer by one step

Key

This method return the current iterated key

Valid

This method validate the current internal position existence

Rewind

This method reinitialize the internal position

Property exist

This method validate that a given property name is part of the current class. This validation allow to the DTO to store a value direcly into an object property instead of the default storage array.

Get properties

This method return the existants properties of the current DTO object. It unset the attribute management properties to allow the only return of storage properties.

By overriding it you can specify any private properties that you want to use inside the final DTO object. This feature must be used with the override of the setProperty() method and getProperty() method.

exemple :

protected function getProperties()
{
     $privateArray = ['propA', 'propB'];

     return array_merge(
         parent::getProperties(),
         $privateArray
     );
}

Set property

This method inject a value into an existing class property. This offer to the DTO to store a value into object properties since current attribute container.

By overriding this method you can store a value into a private class property. This feature must be used in addition with the override of the getProperties() method and getProperty() method.

exemple :

protected function setProperty(string $propertyName, $propertyValue)
{
     if (in_array($propertyName, ['privatePropA', 'privatePropB'])) {
         $method = 'set'.ucfirst($propertyName);
         $this->$method($propertyValue);
         return $this;
     }

     return parent::setProperty($propertyName, $propertyValue);
}

Get property

This method return a value contained into any existing property of the current DTO.

By overriding this method you can extract a value from a private class property. This feature must be used with the override of the getProperties() method and setProperty() method.

exemple :

protected function getProperty(string $propertyName)
{
     if (in_array($propertyName, ['privatePropA', 'privatePropB'])) {
         $method = 'get'.ucfirst($propertyName);
         return $this->$method();
     }

     return parent::getProperty($propertyName);
}