Class \Prado\Collections\TMap

TMap class

TMap implements a collection that takes key-value pairs.

You can access, add or remove an item with a key by using itemAt, add, and remove. To get the number of the items in the map, use getCount. TMap can also be used like a regular array as follows,

$map[$key]=$value; // add a key-value pair
unset($map[$key]); // remove the value with the specified key
if(isset($map[$key])) // if the map contains the key
foreach($map as $key=>$value) // traverse the items in the map
$n=count($map);  // returns the number of items in the map

Class hierarchy

\Prado\Collections\TMap implements IteratorAggregate, ArrayAccess, Countable

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0

Methods summary
`public`	`__construct([null\|array<string\|int, mixed>\|Iterator $data = null ][, bool\|null $readOnly = null ]) : mixed` Constructor. Initializes the list with an array or an iterable object.
`public`	`add(mixed $key, mixed $value) : mixed` Adds an item into the map. Note, if the specified key already exists, the old value will be overwritten.
`public`	`clear() : void` Removes all items in the map.
`public`	`contains(mixed $key) : bool`
`public`	`copyFrom(mixed $data) : void` Copies iterable data into the map. Note, existing data in the map will be cleared first.
`public`	`count() : int` Returns the number of items in the map. This method is required by \Countable interface.
`public`	`getCount() : int`
`public`	`getIterator() : Iterator` Returns an iterator for traversing the items in the list. This method is required by the interface \IteratorAggregate.
`public`	`getKeys() : array<string\|int, int\|string>`
`public`	`getReadOnly() : bool`
`public`	`itemAt(mixed $key) : mixed` Returns the item with the specified key. This method is exactly the same as offsetGet.
`public`	`keyOf(mixed $item[, bool $multiple = true ]) : false\|mixed`
`public`	`mergeWith(mixed $data) : void` Merges iterable data into the map. Existing data in the map will be kept and overwritten if the keys are the same.
`public`	`offsetExists(mixed $offset) : bool` Returns whether there is an element at the specified offset. This method is required by the interface \ArrayAccess.
`public`	`offsetGet(mixed $offset) : mixed` Returns the element at the specified offset. This method is required by the interface \ArrayAccess.
`public`	`offsetSet(mixed $offset, mixed $item) : void` Sets the element at the specified offset. This method is required by the interface \ArrayAccess.
`public`	`offsetUnset(mixed $offset) : void` Unsets the element at the specified offset. This method is required by the interface \ArrayAccess.
`public`	`remove(mixed $key) : mixed` Removes an item from the map by its key.
`public`	`removeItem(mixed $item) : array<string\|int, mixed>` Removes an item from the map. This removes all of an item from the map.
`public`	`setReadOnly(null\|bool\|string $value) : mixed`
`public`	`toArray() : array<int\|string, mixed>`
`protected`	`_getZappableSleepProps(array<string\|int, mixed> &$exprops) : mixed` 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. Reimplement in derived classes to add new variables, but remember to also to call the parent implementation first.
`protected`	`collapseReadOnly() : void` This sets the read only property.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEventHandlers, getListeningToGlobalEvents, getSubProperty, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, listen, raiseEvent, setSubProperty, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx

Inherited constants
`\Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Collections\TMap

Class hierarchy