Return an array of element value changes that have been made to this Map

This is useful for getting the original value of a value that has changed. Such as an original index number or other identifier.

Return any new elements in the Map

Return a list of keys that have been removed

Test if an element exists in the Map object.

Test if there are any changes to this Map object. Changes include not just changes to element values but any new elements added or any elements being removed.

Test if there are any new elements in the Map

Test if any values have been removed

Searches a numeric keyed array for a value that is contained within it and returns true if it exists.

Test if a child value is true NULL. This is the correct way to test for null on a Map object as it will correctly return true for elements that don’t exist.

Test if an object is a usable Array.

Return the current key from the Map

Returns an array of key names currently in this Map object

Lock the map so that it’s values can not be accidentally changed.

Modify multiple elements in one go. Unlike extends this will only modify a value that already exists in the Map.

Move to the next element in the Map

This will by default pop an element off the end of an array. However this method allows for an element key to be specified which will pop that specific element off the Map.

Populate sets up the array with initial values.

• This can be used to construct the initial array after it has been instatiated.
• It can also be used to reset an array with different values

Input filters are also applied at this point so that default elements can also be modified.

Push an element on to the end of the Map

Read will return either the value stored with the specified key, or the default value. This is essentially same as doing:

Remove an element from the Map based on search criteria

Reset the Map back to its default values

Set the internal pointer the first element

Set key value. Filters are applied/executed at this point for element types specified in the ‘in’ filter definition.

Shift an element off of the front of the Map

Return a total of all numeric values in the Map.

Return the Map as a standard Array

Converts/reduces a multidimensional array into a single dimensional array with keys in dot-notation.

Return a valid JSON string representation of the Map

Convert the map to a string. This is for compatibility with certain other functions that may attempt to use these objects as a string. If the map contains any elements it will return ‘%Map’, otherwise it will return an empty string.

Unlock the map so that it’s values can be changed.

Push an element on to the front of the Map

This method will update existing values in the current Map object with the values in the supplied $value array or Map. If the values do not already exist in the current Map object, no new values will be created.

Test that an element exists at the current internal pointer position