Référence de la classe FOFConfigDomainViews

Graphe d'héritage de FOFConfigDomainViews:

Fonctions membres publiques
	parseDomain (SimpleXMLElement $xml, array &$ret)
	get (&$configuration, $var, $default)

Fonctions membres protégées
	getTaskmap ($view, &$configuration, $params, $default=array())
	getAcl ($view, &$configuration, $params, $default='')
	getConfig ($view, &$configuration, $params, $default=null)
	getToolbar ($view, &$configuration, $params, $default='')

Documentation des fonctions membres

get()

get	(	&	$configuration,
			$var,
			$default
	)

Return a configuration variable

Paramètres

string	&$configuration	Configuration variables (hashed array)
string	$var	The variable we want to fetch
mixed	$default	Default value

Renvoie

mixed The variable's value

Implémente FOFConfigDomainInterface.

Références $default, $parts, et $view.

getAcl()

getAcl (   $view, &  $configuration,   $params,   $default = ''  )

protected

Internal method to return the ACL mapping (privilege required to access a specific task) for the given view's tasks

Paramètres

string	$view	The view for which we will be fetching a task map
array	&$configuration	The configuration parameters hash array
array	$params	Extra options; key 0 defines the task we want to fetch
string	$default	Default ACL option; empty (no ACL check) if not defined

Renvoie

string The privilege required to access this view

Références $default, $params, et $view.

getConfig()

getConfig (   $view, &  $configuration,   $params,   $default = null  )

protected

Internal method to return the a configuration option for the view. These are equivalent to $config array options passed to the Controller

Paramètres

string	$view	The view for which we will be fetching a task map
array	&$configuration	The configuration parameters hash array
array	$params	Extra options; key 0 defines the option variable we want to fetch
mixed	$default	Default option; null if not defined

Renvoie

string The setting for the requested option

Références $default, $params, et $view.

getTaskmap()

getTaskmap (   $view, &  $configuration,   $params,   $default = array()  )

protected

Internal function to return the task map for a view

Paramètres

string	$view	The view for which we will be fetching a task map
array	&$configuration	The configuration parameters hash array
array	$params	Extra options (not used)
array	$default	ßDefault task map; empty array if not provided

Renvoie

array The task map as a hash array in the format task => method

Références $default, et $view.

getToolbar()

getToolbar (   $view, &  $configuration,   $params,   $default = ''  )

protected

Internal method to return the toolbar infos.

Paramètres

string	$view	The view for which we will be fetching buttons
array	&$configuration	The configuration parameters hash array
array	$params	Extra options
string	$default	Default option

Renvoie

string The toolbar data for this view

Références $default, $params, $toolbar, et $view.

parseDomain()

parseDomain	(	SimpleXMLElement	$xml,
		array &	$ret
	)

Parse the XML data, adding them to the $ret array

Paramètres

SimpleXMLElement	$xml	The XML data of the component's configuration area
array	&$ret	The parsed data, in the form of a hash array

Renvoie

void

Implémente FOFConfigDomainInterface.

Références $button, $key, et $option.

---

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

• views.php