PHP Class FOF30\Configuration\Domain\Models

Since: 2.1
Inheritance: implements FOF30\Configuration\Domain\DomainInterface
Show file Open project: akeeba/fof

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

Protected Methods

Method Description
getBehaviors ( string $model, &$configuration, array $params, string $default = '' ) : string Internal method to get model behaviours
getConfig ( string $model, &$configuration, array $params, mixed $default = null ) : string Internal method to return the a configuration option for the Model.
getField ( string $model, &$configuration, array $params, string $default = '' ) : array Internal method to return the magic field mapping
getRelations ( string $model, &$configuration, array $params, string $default = '' ) : array Internal method to get model relations
getTablealias ( string $model, &$configuration, array $params, string $default = '' ) : string Internal method to get model alias

Method Details

get() public method

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

getBehaviors() protected method

Internal method to get model behaviours
protected getBehaviors ( string $model, &$configuration, array $params, string $default = '' ) : string
$model string The model for which we will be fetching behaviours
$params array Unused
$default string Default behaviour
return string Model behaviours

getConfig() protected method

Internal method to return the a configuration option for the Model.
protected getConfig ( string $model, &$configuration, array $params, mixed $default = null ) : string
$model 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

getField() protected method

Internal method to return the magic field mapping
protected getField ( string $model, &$configuration, array $params, string $default = '' ) : array
$model string The model for which we will be fetching a field map
$params array Extra options
$default string Default magic field mapping; empty if not defined
return array Field map

getRelations() protected method

Internal method to get model relations
protected getRelations ( string $model, &$configuration, array $params, string $default = '' ) : array
$model string The model for which we will be fetching relations
$params array Unused
$default string Default relations
return array Model relations

getTablealias() protected method

Internal method to get model alias
protected getTablealias ( string $model, &$configuration, array $params, string $default = '' ) : string
$model string The model for which we will be fetching table alias
$params array Ignored
$default string Default table alias
return string Table alias

parseDomain() public method

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