Interface for a list of typed data.
A list of typed data contains only items of the same type, is ordered and may contain duplicates.
When implementing this interface which extends Traversable, make sure to list IteratorAggregate or Iterator before this interface in the implements clause.
Expanded class hierarchy of ListInterface
All classes that implement ListInterface
interface ListInterface extends TypedDataInterface, ArrayAccess, Countable, Traversable {
/**
* Determines whether the list contains any non-empty items.
*
* @return boolean
* TRUE if the list is empty, FALSE otherwise.
*/
public function isEmpty();
/**
* Gets the definition of a contained item.
*
* @return array
* The data definition of contained items.
*/
public function getItemDefinition();
/**
* React to changes to a child item.
*
* Note that this is invoked before any changes are applied.
*
* @param $delta
* The delta of the item which is changed.
*/
public function onChange($delta);
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ListInterface:: |
public | function | Gets the definition of a contained item. | 2 |
ListInterface:: |
public | function | Determines whether the list contains any non-empty items. | 2 |
ListInterface:: |
public | function | React to changes to a child item. | 2 |
TypedDataInterface:: |
public | function | Gets a list of validation constraints. | 4 |
TypedDataInterface:: |
public | function | Gets the data definition. | 4 |
TypedDataInterface:: |
public | function | Returns the name of a property or item. | 4 |
TypedDataInterface:: |
public | function | Returns the parent data structure; i.e. either complex data or a list. | 4 |
TypedDataInterface:: |
public | function | Returns the property path of the data. | 4 |
TypedDataInterface:: |
public | function | Returns the root of the typed data tree. | 4 |
TypedDataInterface:: |
public | function | Returns a string representation of the data. | 4 |
TypedDataInterface:: |
public | function | Gets the data type. | 5 |
TypedDataInterface:: |
public | function | Gets the data value. | 4 |
TypedDataInterface:: |
public | function | Sets the context of a property or item via a context aware parent. | 4 |
TypedDataInterface:: |
public | function | Sets the data value. | 4 |
TypedDataInterface:: |
public | function | Validates the currently set data value. | 4 |