Joomla! API

The magic call method is used to call object methods using the iterator.

__call(string $method, array $arguments = array()) : array

Example: $array = $objectList->foo('bar');

The object list will iterate over its objects and see if each object has a callable 'foo' method. If so, it will pass the argument list and assemble any return values. If an object does not have a callable method no return value is recorded. The keys of the objects and the result array are maintained.

since	1.0

Arguments

$method: stringThe name of the method called.
$arguments: arrayThe arguments of the method called.

Response

arrayAn array of values returned by the methods called on the objects in the data set.

The class constructor.

__construct(array<mixed,\Joomla\Data\DataObject> $objects = array())

since	1.0
throws	`\InvalidArgumentException`if an object is not an instance of Data\Object.

Arguments

$objects: array<mixed,\Joomla\Data\DataObject>An array of DataObject objects to bind to the data set.

The magic get method is used to get a list of properties from the objects in the data set.

__get(string $property) : array

Example: $array = $dataSet->foo;

This will return a column of the values of the 'foo' property in all the objects (or values determined by custom property setters in the individual Data\Object's). The result array will contain an entry for each object in the list (compared to __call which may not). The keys of the objects and the result array are maintained.

since	1.0

Arguments

$property: stringThe name of the data property.

Response

arrayAn associative array of the values.

The magic isset method is used to check the state of an object property using the iterator.

__isset(string $property) : boolean

Example: $array = isset($objectList->foo);

since	1.0

Arguments

$property: stringThe name of the property.

Response

booleanTrue if the property is set in any of the objects in the data set.

The magic set method is used to set an object property using the iterator.

__set(string $property, mixed $value) : void

Example: $objectList->foo = 'bar';

This will set the 'foo' property to 'bar' in all of the objects (or a value determined by custom property setters in the Data\Object).

since	1.0

Arguments

$property: stringThe name of the property.
$value: mixedThe value to give the data property.

The magic unset method is used to unset an object property using the iterator.

__unset(string $property) : void

Example: unset($objectList->foo);

This will unset all of the 'foo' properties in the list of Data\Object's.

since	1.0

Arguments

$property: stringThe name of the property.

Initialises the list with an array of objects.

_initialise(array $input = array()) : void

since	1.0
throws	`\InvalidArgumentException`if an object is not an instance of Data\DataObject.

Arguments

$input: arrayAn array of objects.

Clears the objects in the data set.

clear() : \Joomla\Data\DataSet

since	1.0

Response

\Joomla\Data\DataSetReturns itself to allow chaining.

Gets the number of data objects in the set.

count() : integer

since	1.0

Response

integerThe number of objects.

Get the current data object in the set.

current() : \Joomla\Data\DataObject

since	1.0

Response

\Joomla\Data\DataObjectThe current object, or false if the array is empty or the pointer is beyond the end of the elements.

Dumps the data object in the set, recursively if appropriate.

dump(integer $depth = 3, \SplObjectStorage $dumped = null) : array

see	\Joomla\Data\DataObject::dump()
since	1.0

Arguments

$depth: integerThe maximum depth of recursion (default = 3). For example, a depth of 0 will return a stdClass with all the properties in native form. A depth of 1 will recurse into the first level of properties only.
$dumped: \SplObjectStorageAn array of already serialized objects that is used to avoid infinite loops.

Response

arrayAn associative array of the data objects in the set, dumped as a simple PHP stdClass object.

Gets an array of keys, existing in objects

getObjectsKeys(string $type = 'all') : array

since	1.2.0
throws	`\InvalidArgumentException`

Arguments

$type: stringSelection type 'all' or 'common'

Response

arrayArray of keys

Gets the data set in a form that can be serialised to JSON format.

jsonSerialize(mixed $serialized = null) : array

Note that this method will not return an associative array, otherwise it would be encoded into an object. JSON decoders do not consistently maintain the order of associative keys, whereas they do maintain the order of arrays.

since	1.0

Arguments

$serialized: mixedAn array of objects that have already been serialized that is used to infinite loops (null on first call).

Response

arrayAn array that can be serialised by json_encode().

Gets the key of the current object in the iterator.

key() : scalar

since	1.0

Response

scalarThe object key on success; null on failure.

Gets the array of keys for all the objects in the iterator (emulates array_keys).

keys() : array

since	1.0

Response

arrayThe array of keys

Advances the iterator to the next object in the iterator.

next() : void

since	1.0

Checks whether an offset exists in the iterator.

offsetExists(mixed $offset) : boolean

since	1.0

Arguments

$offset: mixedThe object offset.

Response

booleanTrue if the object exists, false otherwise.

Gets an offset in the iterator.

offsetGet(mixed $offset) : \Joomla\Data\DataObject

since	1.0

Arguments

$offset: mixedThe object offset.

Response

\Joomla\Data\DataObjectThe object if it exists, null otherwise.

Sets an offset in the iterator.

offsetSet(mixed $offset, \Joomla\Data\DataObject $object) : void

since	1.0
throws	`\InvalidArgumentException`if an object is not an instance of Data\Object.

Arguments

$offset: mixedThe object offset.
$object: \Joomla\Data\DataObjectThe object object.

Unsets an offset in the iterator.

offsetUnset(mixed $offset) : void

since	1.0

Arguments

$offset: mixedThe object offset.

Rewinds the iterator to the first object.

rewind() : void

since	1.0

Gets all objects as an array

toArray(boolean $associative = true, string $k = null) : array

since	1.2.0

Arguments

$associative: booleanOption to set return mode: associative or numeric array.
$k: stringUnlimited optional property names to extract from objects.

Response

arrayReturns an array according to defined options.

Validates the iterator.

valid() : boolean

since	1.0

Response

booleanTrue if valid, false otherwise.

Applies a function to every object in the set (emulates array_walk).

walk(callable $funcname) : boolean

since	1.2.0
throws	`\InvalidArgumentException`

Arguments

$funcname: callableCallback function.

Response

boolean

The current position of the iterator.

since	1.0

Type(s)

integer

The iterator objects.

since	1.0

Type(s)

array<mixed,\Joomla\Data\DataObject>

DataSet

Methods

__call

Arguments

Response

__construct

Arguments

__get

Arguments

Response

__isset

Arguments

Response

__set

Arguments

__unset

Arguments

_initialise

Arguments

clear

Response

count

Response

current

Response

dump

Arguments

Response

getObjectsKeys

Arguments

Response

jsonSerialize

Arguments

Response

key

Response

keys

Response

next

offsetExists

Arguments

Response

offsetGet

Arguments

Response

offsetSet

Arguments

offsetUnset

Arguments

rewind

toArray

Arguments

Response

valid

Response

walk

Arguments

Response

Properties

current

Type(s)

objects

Type(s)