PHP Class FOF30\Configuration\Domain\Views

Since: 2.1

Inheritance: implements FOF30\Configuration\Domain\DomainInterface

Public Methods

Method	Description
get ( &$configuration, string $var, mixed $default ) : mixed	Return a configuration variable
parseDomain ( SimpleXMLElement $xml, array &$ret ) : void	Parse the XML data, adding them to the $ret array

Method	Description
getAcl ( string $view, &$configuration, array $params, string $default = '' ) : string	Internal method to return the ACL mapping (privilege required to access a specific task) for the given view's tasks
getConfig ( string $view, &$configuration, array $params, mixed $default = null ) : string	Internal method to return the a configuration option for the view. These are equivalent to $config array options passed to the Controller
getTaskmap ( string $view, &$configuration, array $params, array $default = [] ) : array	Internal function to return the task map for a view
getToolbar ( string $view, &$configuration, array $params, string $default = '' ) : string	Internal method to return the toolbar infos.

Return a configuration variable

public get ( &$configuration, string $var, mixed $default ) : mixed
$var	string	The variable we want to fetch
$default	mixed	Default value
return	mixed	The variable's value

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

protected getAcl ( string $view, &$configuration, array $params, string $default = '' ) : string
$view	string	The view for which we will be fetching a task map
$params	array	Extra options; key 0 defines the task we want to fetch
$default	string	Default ACL option; empty (no ACL check) if not defined
return	string	The privilege required to access this view

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

protected getConfig ( string $view, &$configuration, array $params, mixed $default = null ) : string
$view	string	The view for which we will be fetching a task map
$params	array	Extra options; key 0 defines the option variable we want to fetch
$default	mixed	Default option; null if not defined
return	string	The setting for the requested option

Internal function to return the task map for a view

protected getTaskmap ( string $view, &$configuration, array $params, array $default = [] ) : array
$view	string	The view for which we will be fetching a task map
$params	array	Extra options (not used)
$default	array	ßDefault task map; empty array if not provided
return	array	The task map as a hash array in the format task => method

Internal method to return the toolbar infos.

protected getToolbar ( string $view, &$configuration, array $params, string $default = '' ) : string
$view	string	The view for which we will be fetching buttons
$params	array	Extra options
$default	string	Default option
return	string	The toolbar data for this view

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

public parseDomain ( SimpleXMLElement $xml, array &$ret ) : void
$xml	SimpleXMLElement	The XML data of the component's configuration area
$ret	array
return	void