Home » Documentation » Class Reference » CAttributeCollection

CAttributeCollection

Package	system.collections
Inheritance	class CAttributeCollection » CMap » CComponent
Implements	Countable, ArrayAccess, Traversable, IteratorAggregate
Since	1.0
Version	$Id: CAttributeCollection.php 1678 2010-01-07 21:02:00Z qiang.xue $

CAttributeCollection implements a collection for storing attribute names and values.

Besides all functionalities provided by CMap, CAttributeCollection allows you to get and set attribute values like getting and setting properties. For example, the following usages are all valid for a CAttributeCollection object:

$collection->text='text'; // same as:  $collection->add('text','text');
echo $collection->text;   // same as:  echo $collection->itemAt('text');

The case sensitivity of attribute names can be toggled by setting the caseSensitive property of the collection.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
caseSensitive	boolean	whether the keys are case-sensitive.	CAttributeCollection
count	integer	the number of items in the map	CMap
iterator	CMapIterator	Returns an iterator for traversing the items in the list.	CMap
keys	array	the key list	CMap
readOnly	boolean	whether this map is read-only or not.	CMap

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	CComponent
__construct()	Constructor.	CMap
__get()	Returns a property value or an event handler list by property or event name.	CAttributeCollection
__isset()	Checks if a property value is null.	CAttributeCollection
__set()	Sets value of a component property.	CAttributeCollection
__unset()	Sets a component property to be null.	CAttributeCollection
add()	Adds an item into the map.	CAttributeCollection
asa()	Returns the named behavior object.	CComponent
attachBehavior()	Attaches a behavior to this component.	CComponent
attachBehaviors()	Attaches a list of behaviors to the component.	CComponent
attachEventHandler()	Attaches an event handler to an event.	CComponent
canGetProperty()	Determines whether a property can be read.	CAttributeCollection
canSetProperty()	Determines whether a property can be set.	CAttributeCollection
clear()	Removes all items in the map.	CMap
contains()	Returns whether the specified is in the map.	CAttributeCollection
copyFrom()	Copies iterable data into the map.	CMap
count()	Returns the number of items in the map.	CMap
detachBehavior()	Detaches a behavior from the component.	CComponent
detachBehaviors()	Detaches all behaviors from the component.	CComponent
detachEventHandler()	Detaches an existing event handler.	CComponent
disableBehavior()	Disables an attached behavior.	CComponent
disableBehaviors()	Disables all behaviors attached to this component.	CComponent
enableBehavior()	Enables an attached behavior.	CComponent
enableBehaviors()	Enables all behaviors attached to this component.	CComponent
evaluateExpression()	Evaluates a PHP expression or callback under the context of this component.	CComponent
getCount()		CMap
getEventHandlers()	Returns the list of attached event handlers for an event.	CComponent
getIterator()	Returns an iterator for traversing the items in the list.	CMap
getKeys()		CMap
getReadOnly()		CMap
hasEvent()	Determines whether an event is defined.	CComponent
hasEventHandler()	Checks whether the named event has attached handlers.	CComponent
hasProperty()	Determines whether a property is defined.	CAttributeCollection
itemAt()	Returns the item with the specified key.	CAttributeCollection
mergeArray()	Merges two arrays into one recursively.	CMap
mergeWith()	Merges iterable data into the map.	CMap
offsetExists()	Returns whether there is an element at the specified offset.	CMap
offsetGet()	Returns the element at the specified offset.	CMap
offsetSet()	Sets the element at the specified offset.	CMap
offsetUnset()	Unsets the element at the specified offset.	CMap
raiseEvent()	Raises an event.	CComponent
remove()	Removes an item from the map by its key.	CAttributeCollection
toArray()		CMap

Protected Methods

Hide inherited methods

Method	Description	Defined By
setReadOnly()		CMap

Property Details

caseSensitive property

public boolean $caseSensitive;

whether the keys are case-sensitive. Defaults to false.

Method Details

__get() method

public mixed __get(string $name)
$name	string	the property name or the event name
{return}	mixed	the property value or the event handler list

Returns a property value or an event handler list by property or event name. This method overrides the parent implementation by returning a key value if the key exists in the collection.

__isset() method (available since v1.0.1)

public boolean __isset(string $name)
$name	string	the property name or the event name
{return}	boolean	whether the property value is null

Checks if a property value is null. This method overrides the parent implementation by checking if the key exists in the collection and contains a non-null value.

__set() method

public void __set(string $name, mixed $value)
$name	string	the property name or event name
$value	mixed	the property value or event handler

Sets value of a component property. This method overrides the parent implementation by adding a new key value to the collection.

__unset() method (available since v1.0.1)

public void __unset(string $name)
$name	string	the property name or the event name

Sets a component property to be null. This method overrides the parent implementation by clearing the specified key value.

add() method

public void add(mixed $key, mixed $value)
$key	mixed	key
$value	mixed	value

Adds an item into the map. This overrides the parent implementation by converting the key to lower case first if caseSensitive is false.

canGetProperty() method

public boolean canGetProperty(string $name)
$name	string	the property name
{return}	boolean	whether the property can be read

Determines whether a property can be read. This method overrides parent implementation by returning true if the collection contains the named key.

canSetProperty() method

public boolean canSetProperty(string $name)
$name	string	the property name
{return}	boolean	true

Determines whether a property can be set. This method overrides parent implementation by always returning true because you can always add a new value to the collection.

contains() method

public boolean contains(mixed $key)
$key	mixed	the key
{return}	boolean	whether the map contains an item with the specified key

Returns whether the specified is in the map. This overrides the parent implementation by converting the key to lower case first if caseSensitive is false.

hasProperty() method

public boolean hasProperty(string $name)
$name	string	the property name
{return}	boolean	whether the property is defined

Determines whether a property is defined. This method overrides parent implementation by returning true if the collection contains the named key.

itemAt() method

public mixed itemAt(mixed $key)
$key	mixed	the key
{return}	mixed	the element at the offset, null if no element is found at the offset

Returns the item with the specified key. This overrides the parent implementation by converting the key to lower case first if caseSensitive is false.

remove() method

public mixed remove(mixed $key)
$key	mixed	the key of the item to be removed
{return}	mixed	the removed value, null if no such key exists.

Removes an item from the map by its key. This overrides the parent implementation by converting the key to lower case first if caseSensitive is false.