Class FOFConfigDomainViews
Configuration parser for the view-specific settings
-
FOFConfigDomainViews
implements
FOFConfigDomainInterface
Methods summary
public
|
#
parseDomain( SimpleXMLElement $xml, array & $ret )
Parse the XML data, adding them to the $ret array
Parse the XML data, adding them to the $ret array
Parameters
- $xml
SimpleXMLElement- $ret
array - &$ret The parsed data, in the form of a hash array Implementation of
|
public
mixed
|
#
get( string & $configuration, string $var, mixed $default )
Return a configuration variable
Return a configuration variable
Parameters
- $configuration
string - &$configuration Configuration variables (hashed array)- $var
string - $var The variable we want to fetch- $default
mixed - $default Default value Returns
mixed - The variable's value
Implementation of
|
protected
array
|
#
getTaskmap( string $view, array & $configuration, array $params, array $default = array() )
Internal function to return the task map for a view
Internal function to return the task map for a view
Parameters
- $view
string - $view The view for which we will be fetching a task map- $configuration
array - &$configuration The configuration parameters hash array- $params
array - $params Extra options (not used)- $default
array - $default ßDefault task map; empty array if not provided Returns
array - The task map as a hash array in the format task => method
|
protected
string
|
#
getAcl( string $view, array & $configuration, array $params, string $default = '' )
Internal method to return the ACL mapping (privilege required to access a
specific task) for the given view's tasks
Internal method to return the ACL mapping (privilege required to access a
specific task) for the given view's tasks
Parameters
- $view
string - $view The view for which we will be fetching a task map- $configuration
array - &$configuration The configuration parameters hash array- $params
array - $params Extra options; key 0 defines the task we want to fetch- $default
string - $default Default ACL option; empty (no ACL check) if not defined Returns
string - The privilege required to access this view
|
protected
string
|
#
getConfig( string $view, array & $configuration, array $params, mixed $default = null )
Internal method to return the a configuration option for the view. These are
equivalent to $config array options passed to the Controller
Internal method to return the a configuration option for the view. These are
equivalent to $config array options passed to the Controller
Parameters
- $view
string - $view The view for which we will be fetching a task map- $configuration
array - &$configuration The configuration parameters hash array- $params
array - $params Extra options; key 0 defines the option variable we want to fetch- $default
mixed - $default Default option; null if not defined Returns
string - The setting for the requested option
|
protected
string
|
#
getToolbar( string $view, array & $configuration, array $params, string $default = '' )
Internal method to return the toolbar infos.
Internal method to return the toolbar infos.
Parameters
- $view
string - $view The view for which we will be fetching buttons- $configuration
array - &$configuration The configuration parameters hash array- $params
array - $params Extra options- $default
string - $default Default option Returns
string - The toolbar data for this view
|
Magic methods summary
