Référence de la classe DataSet

Graphe d'héritage de DataSet:

Fonctions membres publiques
	__construct (array $objects=[])
	__call ($method, $arguments=[])
	__get ($property)
	__isset ($property)
	__set ($property, $value)
	__unset ($property)
	getObjectsKeys ($type='all')
	toArray ($associative=true,... $keys)
	count ()
	clear ()
	current ()
	dump ($depth=3, \SplObjectStorage $dumped=null)
	jsonSerialize ()
	key ()
	keys ()
	walk (callable $funcname)
	next ()
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $object)
	offsetUnset ($offset)
	rewind ()
	valid ()

Fonctions membres privées
	initialise (array $input=[])

Attributs privés
	$current = false
	$objects = []

Description détaillée

DataSet is a collection class that allows the developer to operate on a set of DataObjects as if they were in a typical PHP array.

Depuis

1.0

Documentation des constructeurs et destructeur

__construct()

__construct

(

array

$objects = []

)

The class constructor.

Paramètres

DataObject[]

$objects An array of DataObject objects to bind to the data set.

Depuis

1.0

Exceptions

Références DataSet\$objects, et DataSet\initialise().

Documentation des fonctions membres

__call()

__call	(		$method,
			$arguments = []
	)

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

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.

Paramètres

string	$method	The name of the method called.
array	$arguments	The arguments of the method called.

Renvoie

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

Depuis

1.0

Références $key, $method, et $return.

__get()

__get

(

$property

)

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

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 DataObject'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.

Paramètres

string

$property

The name of the data property.

Renvoie

array An associative array of the values.

Depuis

1.0

Références $key, et $return.

__isset()

__isset

(

$property

)

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

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

Paramètres

string

$property

The name of the property.

Renvoie

boolean True if the property is set in any of the objects in the data set.

Depuis

1.0

Références $return.

__set()

__set	(		$property,
			$value
	)

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

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 DataObject).

Paramètres

string	$property	The name of the property.
mixed	$value	The value to give the data property.

Renvoie

void

Depuis

1.0

Références $value.

__unset()

__unset

(

$property

)

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

Example: unset($objectList->foo);

This will unset all of the 'foo' properties in the list of DataObject's.

Paramètres

string

$property

The name of the property.

Renvoie

void

Depuis

1.0

clear()

clear

(

)

Clears the objects in the data set.

Renvoie

DataSet Returns itself to allow chaining.

Depuis

1.0

Références $this, et DataSet\rewind().

count()

count

(

)

Gets the number of data objects in the set.

Renvoie

integer The number of objects.

Depuis

1.0

current()

current

(

)

Get the current data object in the set.

Renvoie

DataObject|false The current object, or false if the array is empty or the pointer is beyond the end of the elements.

Depuis

1.0

Références DataSet\$current.

dump()

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

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

Paramètres

integer	$depth	The 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.
\SplObjectStorage	$dumped	An array of already serialized objects that is used to avoid infinite loops.

Renvoie

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

Voir également

DataObject::dump()

Depuis

1.0

Implémente DumpableInterface.

Références $key, DataSet\$objects, $this, et null.

getObjectsKeys()

getObjectsKeys

(

$type = 'all'

)

Gets an array of keys, existing in objects

Paramètres

string

$type

Selection type 'all' or 'common'

Renvoie

array Array of keys

Depuis

1.2.0

Exceptions

Références $function, $type, elseif, et null.

Référencé par DataSet\toArray().

initialise()

initialise ( array  $input = [] )

private

Initialises the list with an array of objects.

Paramètres

array

$input

An array of objects.

Renvoie

void

Depuis

1.0

Exceptions

Références $input, $key, $this, null, et DataSet\rewind().

Référencé par DataSet\__construct().

jsonSerialize()

jsonSerialize

(

)

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

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.

Renvoie

array

Depuis

1.0

Références $return.

key()

key

(

)

Gets the key of the current object in the iterator.

Renvoie

integer|false The object key on success; false on failure.

Depuis

1.0

Références DataSet\$current.

keys()

keys

(

)

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

Renvoie

array The array of keys

Depuis

1.0

Référencé par DataSet\next(), DataSet\offsetUnset(), et DataSet\rewind().

next()

next

(

)

Advances the iterator to the next object in the iterator.

Renvoie

void

Depuis

1.0

Références $position, DataSet\keys(), et null.

offsetExists()

offsetExists

(

$offset

)

Checks whether an offset exists in the iterator.

Paramètres

mixed

$offset

The object offset.

Renvoie

boolean

Depuis

1.0

Références Joomla\Database\Query\$offset.

offsetGet()

offsetGet

(

$offset

)

Gets an offset in the iterator.

Paramètres

mixed

$offset

The object offset.

Renvoie

DataObject|null

Depuis

1.0

Références Joomla\Database\Query\$offset, et null.

offsetSet()

offsetSet	(		$offset,
			$object
	)

Sets an offset in the iterator.

Paramètres

mixed	$offset	The object offset.
DataObject	$object	The object object.

Renvoie

void

Depuis

1.0

Exceptions

Références Joomla\Database\Query\$offset, class, et null.

offsetUnset()

offsetUnset

(

$offset

)

Unsets an offset in the iterator.

Paramètres

mixed

$offset

The object offset.

Renvoie

void

Depuis

1.0

Références Joomla\Database\Query\$offset, $position, $this, et DataSet\keys().

rewind()

rewind

(

)

Rewinds the iterator to the first object.

Renvoie

void

Depuis

1.0

Références DataSet\keys().

Référencé par DataSet\clear(), et DataSet\initialise().

toArray()

toArray	(		$associative = true,
			$keys
	)

Gets all objects as an array

Paramètres

boolean	$associative	Option to set return mode: associative or numeric array.
	string	...$keys Unlimited optional property names to extract from objects.

Renvoie

array Returns an array according to defined options.

Depuis

1.2.0

Références $i, $key, $return, DataSet\getObjectsKeys(), et null.

valid()

valid

(

)

Validates the iterator.

Renvoie

boolean

Depuis

1.0

walk()

walk

(

callable

$funcname

)

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

Paramètres

callable

$funcname

Callback function.

Renvoie

boolean

Depuis

1.2.0

Exceptions

Références $key.

Documentation des champs

$current

$current = false

private

Référencé par DataSet\current(), et DataSet\key().

$objects

$objects = []

private

Référencé par DataSet\__construct(), et DataSet\dump().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• joomla/data/src/DataSet.php