PHP Class Prado\Collections\TAttributeCollection

TAttributeCollection implements a collection for storing attribute names and values. Besides all functionalities provided by {@link TMap}, TAttributeCollection allows you to get and set attribute values like getting and setting properties. For example, the following usages are all valid for a TAttributeCollection object: $collection->Text='text'; echo $collection->Text; They are equivalent to the following: $collection->add('Text','text'); echo $collection->itemAt('Text'); Note, attribute names are case-insensitive. They are converted to lower-case in the collection storage.
Since: 3.0
Author: Qiang Xue ([email protected])
Inheritance: extends TMap
Mostra file Open project: pradosoft/prado Class Usage Examples

Public Methods

Method Description
__get ( $name ) : mixed Returns a property value or an event handler list by property or event name.
__set ( $name, $value ) Sets value of a component property.
add ( $key, $value ) Adds an item into the map.
canGetProperty ( $name ) : boolean Determines whether a property can be read.
canSetProperty ( $name ) : boolean Determines whether a property can be set.
contains ( $key ) : boolean Returns whether the specified is in the map.
getCaseSensitive ( ) : boolean
hasProperty ( $name ) : boolean Determines whether a property is defined.
itemAt ( $key ) : mixed Returns the item with the specified key.
remove ( $key ) : mixed Removes an item from the map by its key.
setCaseSensitive ( $value )

Protected Methods

Method Description
_getZappableSleepProps ( &$exprops ) Returns an array with the names of all variables of this object that should NOT be serialized because their value is the default one or useless to be cached for the next page loads.

Method Details

__get() public method

This method overrides the parent implementation by returning a key value if the key exists in the collection.
public __get ( $name ) : mixed
return mixed the property value or the event handler list

__set() public method

This method overrides the parent implementation by adding a new key value to the collection.
public __set ( $name, $value )

_getZappableSleepProps() protected method

Reimplement in derived classes to add new variables, but remember to also to call the parent implementation first.
protected _getZappableSleepProps ( &$exprops )

add() public method

This overrides the parent implementation by converting the key to lower case first if CaseSensitive is false.
public add ( $key, $value )

canGetProperty() public method

This method overrides parent implementation by returning true if the collection contains the named key.
public canGetProperty ( $name ) : boolean
return boolean whether the property can be read

canSetProperty() public method

This method overrides parent implementation by always returning true because you can always add a new value to the collection.
public canSetProperty ( $name ) : boolean
return boolean true

contains() public method

This overrides the parent implementation by converting the key to lower case first if CaseSensitive is false.
public contains ( $key ) : boolean
return boolean whether the map contains an item with the specified key

getCaseSensitive() public method

public getCaseSensitive ( ) : boolean
return boolean whether the keys are case-sensitive. Defaults to false.

hasProperty() public method

This method overrides parent implementation by returning true if the collection contains the named key.
public hasProperty ( $name ) : boolean
return boolean whether the property is defined

itemAt() public method

This overrides the parent implementation by converting the key to lower case first if CaseSensitive is false.
public itemAt ( $key ) : mixed
return mixed the element at the offset, null if no element is found at the offset

remove() public method

This overrides the parent implementation by converting the key to lower case first if CaseSensitive is false.
public remove ( $key ) : mixed
return mixed the removed value, null if no such key exists.

setCaseSensitive() public method

public setCaseSensitive ( $value )