Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe AggregatedCollector
+ Graphe d'héritage de AggregatedCollector:

Fonctions membres publiques

 __construct ($name, $mergeProperty=null, $sort=false)
 
 addCollector (DataCollectorInterface $collector)
 
 getCollectors ()
 
 setMergeProperty ($property)
 
 getMergeProperty ()
 
 setSort ($sort)
 
 getSort ()
 
 collect ()
 
 getName ()
 
 offsetSet ($key, $value)
 
 offsetGet ($key)
 
 offsetExists ($key)
 
 offsetUnset ($key)
 

Fonctions membres protégées

 sort ($data)
 

Attributs protégés

 $name
 
 $mergeProperty
 
 $sort
 
 $collectors = array()
 

Description détaillée

Aggregates data from multiple collectors

$aggcollector = new AggregateCollector('foobar'); $aggcollector->addCollector(new MessagesCollector('msg1')); $aggcollector->addCollector(new MessagesCollector('msg2')); $aggcollector['msg1']->addMessage('hello world');

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $name,
  $mergeProperty = null,
  $sort = false 
)
Paramètres
string$name
string$mergeProperty
boolean$sort

Références AggregatedCollector\$mergeProperty, AggregatedCollector\$name, AggregatedCollector\$sort, name, et AggregatedCollector\sort().

Documentation des fonctions membres

◆ addCollector()

addCollector ( DataCollectorInterface  $collector)
Paramètres
DataCollectorInterface$collector

Références DataCollectorInterface\getName().

◆ collect()

collect ( )

◆ getCollectors()

getCollectors ( )
Renvoie
array

Références AggregatedCollector\$collectors.

◆ getMergeProperty()

getMergeProperty ( )
Renvoie
string

Références AggregatedCollector\$mergeProperty.

◆ getName()

getName ( )
Renvoie
string

Implémente DataCollectorInterface.

Références AggregatedCollector\$name.

◆ getSort()

getSort ( )
Renvoie
bool|string

Références AggregatedCollector\$sort.

◆ offsetExists()

offsetExists (   $key)
Paramètres
mixed$key
Renvoie
bool

Références $key.

◆ offsetGet()

offsetGet (   $key)
Paramètres
mixed$key
Renvoie
mixed

Références $key.

◆ offsetSet()

offsetSet (   $key,
  $value 
)
Paramètres
mixed$key
mixed$value
Exceptions
DebugBarException

◆ offsetUnset()

offsetUnset (   $key)
Paramètres
mixed$key
Exceptions
DebugBarException

◆ setMergeProperty()

setMergeProperty (   $property)

Merge data from one of the key/value pair of the collected data

Paramètres
string$property

◆ setSort()

setSort (   $sort)

Sorts the collected data

If true, sorts using sort() If it is a string, sorts the data using the value from a key/value pair of the array

Paramètres
bool | string$sort

Références AggregatedCollector\$sort, et AggregatedCollector\sort().

◆ sort()

sort (   $data)
protected

Sorts the collected data

Paramètres
array$data
Renvoie
array

Références $b, $data, AggregatedCollector\$sort, et elseif.

Référencé par AggregatedCollector\__construct(), AggregatedCollector\collect(), et AggregatedCollector\setSort().

Documentation des champs

◆ $collectors

$collectors = array()
protected

◆ $mergeProperty

◆ $name

◆ $sort


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