ArrayAccess Interface Reference
Interface to provide accessing objects as arrays. More...
Inheritance diagram for ArrayAccess:
Public Member Functions | |
| offsetExists ($offset) | |
| offsetGet ($offset) | |
| offsetSet ($offset, $value) | |
| offsetUnset ($offset) | |
Detailed Description
Interface to provide accessing objects as arrays.
Definition at line 10 of file iface_ArrayAccess.php.
Member Function Documentation
| ArrayAccess::offsetExists | ( | $offset | ) |
Whether or not an offset exists.
This method is executed when using isset() or empty() on objects implementing ArrayAccess.
- Parameters
-
mixed $offset An offset to check for.
- Return values
-
bool TRUE is returned when the offset exists, FALSE when it doesn't.
- Note
- When using empty() ArrayAccess::offsetGet() will be called and checked for emptyness only if ArrayAccess::offsetExists() returns TRUE.
Implemented in Plop\Plop, Plop\Record, and Plop\Collection.
| ArrayAccess::offsetGet | ( | $offset | ) |
Returns the value at the specified offset.
This method is executed when checking if offset is empty().
- Parameters
-
mixed $offset The offset to retrieve.
- Return values
-
mixed Value at the specified offset.
Implemented in Plop\Plop, Plop\Record, and Plop\Collection.
| ArrayAccess::offsetSet | ( | $offset, | |
| $value | |||
| ) |
Assigns a value to the specified offset.
- Parameters
-
mixed $offset The offset to assign the value to. mixed $value The value to set.
Implemented in Plop\Plop, Plop\Record, and Plop\Collection.
| ArrayAccess::offsetUnset | ( | $offset | ) |
Unsets an offset.
- Parameters
-
mixed $offset The offset to unset.
- Note
- This method will not be called when type-casting to (unset).
Implemented in Plop\Plop, Plop\Record, and Plop\Collection.
The documentation for this interface was generated from the following file:
- docs/additions/iface_ArrayAccess.php
