PHP Interface eZ\Publish\Core\MVC\ConfigResolverInterface

Classes implementing this interface will help you get settings for a specific scope. In eZ Publish context, this is useful to get a setting for a specific siteaccess for example. The idea is to check the different scopes available for a given namespace to find the appropriate parameter. To work, the dynamic setting must comply internally to the following name format : "..parameter.name".
Mostra file Open project: ezsystems/ezpublish-kernel Interface Usage Examples

Public Methods

Method Description
getDefaultNamespace ( ) : string Returns the current default namespace.
getParameter ( string $paramName, string $namespace = null, string $scope = null ) : mixed Returns value for $paramName, in $namespace.
hasParameter ( string $paramName, string $namespace = null, string $scope = null ) : boolean Checks if $paramName exists in $namespace.
setDefaultNamespace ( string $defaultNamespace ) Changes the default namespace to look parameter into.

Method Details

getDefaultNamespace() public method

Returns the current default namespace.
public getDefaultNamespace ( ) : string
return string

getParameter() public method

Returns value for $paramName, in $namespace.
public getParameter ( string $paramName, string $namespace = null, string $scope = null ) : mixed
$paramName string The parameter name, without $prefix and the current scope (i.e. siteaccess name).
$namespace string Namespace for the parameter name. If null, the default namespace should be used.
$scope string The scope you need $paramName value for.
return mixed

hasParameter() public method

Checks if $paramName exists in $namespace.
public hasParameter ( string $paramName, string $namespace = null, string $scope = null ) : boolean
$paramName string
$namespace string If null, the default namespace should be used.
$scope string The scope you need $paramName value for.
return boolean

setDefaultNamespace() public method

Changes the default namespace to look parameter into.
public setDefaultNamespace ( string $defaultNamespace )
$defaultNamespace string