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

AbstractCSR3DTO

class AbstractCSR3DTO implements CSR3DTOInterface

AbstractCSR3DTO.php

The AbstractCSR3DTO abstract class define the basic usage of the CSR3DTOInterface

Traits

CSR3DTOTrait
CSR3DTOTrait.php

Properties

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

Methods

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

Set attribute

from CSR3DTOTrait
mixed
getAttribute(string $attributeName)

Get attribute

from CSR3DTOTrait
$this
setAttributes(array $attributes)

Set attributes

from CSR3DTOTrait
array
getAttributes()

Get attributes

from CSR3DTOTrait
bool
offsetExists(mixed $offset)

Offset exist

from CSR3DTOTrait
mixed
offsetGet(mixed $offset)

Offset get

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

Offset set

from CSR3DTOTrait
void
offsetUnset(mixed $offset)

Offset unset

from CSR3DTOTrait
mixed
current()

Current

from CSR3DTOTrait
void
next()

Next

from CSR3DTOTrait
void
key()

Key

from CSR3DTOTrait
bool
valid()

Valid

from CSR3DTOTrait
void
rewind()

Rewind

from CSR3DTOTrait

Details

in CSR3DTOTrait 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 CSR3DTOTrait at line 79
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 CSR3DTOTrait at line 97
$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 CSR3DTOTrait at line 113
array getAttributes()

Get attributes

This method return the attributes as array from the DTO

Return Value

array

in CSR3DTOTrait at line 127
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 CSR3DTOTrait at line 141
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 CSR3DTOTrait at line 156
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 CSR3DTOTrait at line 170
void offsetUnset(mixed $offset)

Offset unset

This method remove an offset

Parameters

mixed $offset The offset to remove

Return Value

void

in CSR3DTOTrait at line 182
mixed current()

Current

This method return the current iterated value

Return Value

mixed

in CSR3DTOTrait at line 194
void next()

Next

This method advance the internal pointer by one step

Return Value

void

in CSR3DTOTrait at line 206
void key()

Key

This method return the current iterated key

Return Value

void

in CSR3DTOTrait at line 220
bool valid()

Valid

This method validate the current internal position existence

Return Value

bool

in CSR3DTOTrait at line 236
void rewind()

Rewind

This method reinitialize the internal position

Return Value

void