1. class
  2. CSDT
  3. CSR3
  4. Abstracts
  5. AbstractCSR3PropertyDTO

AbstractCSR3PropertyDTO

class AbstractCSR3PropertyDTO implements CSR3DTOInterface

AbstractCSR3PropertyDTO.php

The AbstractCSR3PropertyDTO define the base implémentation of the CSR3DTOInterface with property definition capability

Traits

CSR3PropertyDTOTrait
CSR3PropertyDTOTrait.php

Properties

protected string $attributeContainer Attribute container from CSR3PropertyDTOTrait
protected string $positionContainer Position container from CSR3PropertyDTOTrait

Methods

$this
setAttribute(string $attributeName, mixed $attributeValue)

Set attribute

from CSR3PropertyDTOTrait
mixed
getAttribute(string $attributeName)

Get attribute

from CSR3PropertyDTOTrait
$this
setAttributes(array $attributes)

Set attributes

from CSR3PropertyDTOTrait
array
getAttributes()

Get attributes

from CSR3PropertyDTOTrait
bool
offsetExists(mixed $offset)

Offset exist

from CSR3PropertyDTOTrait
mixed
offsetGet(mixed $offset)

Offset get

from CSR3PropertyDTOTrait
void
offsetSet(mixed $offset, mixed $value)

Offset set

from CSR3PropertyDTOTrait
void
offsetUnset(mixed $offset)

Offset unset

from CSR3PropertyDTOTrait
mixed
current()

Current

from CSR3PropertyDTOTrait
void
next()

Next

from CSR3PropertyDTOTrait
void
key()

Key

from CSR3PropertyDTOTrait
bool
valid()

Valid

from CSR3PropertyDTOTrait
void
rewind()

Rewind

from CSR3PropertyDTOTrait
propertyExist($propertyName)

No description

from CSR3PropertyDTOTrait
getProperties()

No description

from CSR3PropertyDTOTrait
setProperty($propertyName, $propertyValue)

No description

from CSR3PropertyDTOTrait
getProperty($propertyName)

No description

from CSR3PropertyDTOTrait

Details

in CSR3PropertyDTOTrait at line 61
$this setAttribute(string $attributeName, mixed $attributeValue)

Set attribute

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

Parameters

string $attributeName The attribute to set
mixed $attributeValue The value to set

Return Value

$this

in CSR3PropertyDTOTrait at line 85
mixed getAttribute(string $attributeName)

Get attribute

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

Parameters

string $attributeName The name of the attribute whence return the value

Return Value

mixed

in CSR3PropertyDTOTrait at line 107
$this setAttributes(array $attributes)

Set attributes

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

Parameters

array $attributes The associative array of attributes

Return Value

$this

in CSR3PropertyDTOTrait at line 128
array getAttributes()

Get attributes

This method return the attributes as array from the DTO

Return Value

array

in CSR3PropertyDTOTrait at line 148
bool offsetExists(mixed $offset)

Offset exist

This method validate the existence of an offset

Parameters

mixed $offset The offset to validate

Return Value

bool

in CSR3PropertyDTOTrait at line 166
mixed offsetGet(mixed $offset)

Offset get

This method return an offset value

Parameters

mixed $offset The offset whence retreive the value

Return Value

mixed

in CSR3PropertyDTOTrait at line 181
void offsetSet(mixed $offset, mixed $value)

Offset set

This method allow to set a value at an offset place

Parameters

mixed $offset The offset where set the value
mixed $value The value to inject

Return Value

void

in CSR3PropertyDTOTrait at line 195
void offsetUnset(mixed $offset)

Offset unset

This method remove an offset

Parameters

mixed $offset The offset to remove

Return Value

void

in CSR3PropertyDTOTrait at line 211
mixed current()

Current

This method return the current iterated value

Return Value

mixed

in CSR3PropertyDTOTrait at line 223
void next()

Next

This method advance the internal pointer by one step

Return Value

void

in CSR3PropertyDTOTrait at line 235
void key()

Key

This method return the current iterated key

Return Value

void

in CSR3PropertyDTOTrait at line 247
bool valid()

Valid

This method validate the current internal position existence

Return Value

bool

in CSR3PropertyDTOTrait at line 261
void rewind()

Rewind

This method reinitialize the internal position

Return Value

void

in CSR3PropertyDTOTrait at line 266
protected propertyExist($propertyName)

Parameters

$propertyName

in CSR3PropertyDTOTrait at line 271
protected getProperties()

in CSR3PropertyDTOTrait at line 283
protected setProperty($propertyName, $propertyValue)

Parameters

$propertyName
$propertyValue

in CSR3PropertyDTOTrait at line 288
protected getProperty($propertyName)

Parameters

$propertyName