ConfigResolverInterface

ConfigResolverInterface.php : 18 Copy path

Interface for config resolvers.

Classes implementing this interface will help you get settings for a specific scope. In Ibexa 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".

Methods¶

getDefaultNamespace() ¶

ConfigResolverInterface.php : 48 Copy path

Returns the current default namespace.

public getDefaultNamespace() : string

Return values

string

getParameter() ¶

ConfigResolverInterface.php : 29 Copy path

Returns value for $paramName, in $namespace.

    
                        public getParameter(string $paramName[, string $namespace = null ][, string $scope = null ]) : mixed

Parameters

Name	Type	Default value	Description
$paramName	string	-	The parameter name, without $prefix and the current scope (i.e. siteaccess name).
$namespace	string	null	Namespace for the parameter name. If null, the default namespace should be used.
$scope	string	null	The scope you need $paramName value for.

hasParameter() ¶

ConfigResolverInterface.php : 38 Copy path

Checks if $paramName exists in $namespace.

    
                        public hasParameter(string $paramName[, string $namespace = null ][, string $scope = null ]) : bool

Parameters

Name	Type	Default value	Description
$paramName	string	-	The parameter name, without $prefix and the current scope (i.e. siteaccess name).
$namespace	string	null	Namespace for the parameter name. If null, the default namespace should be used.
$scope	string	null	The scope you need $paramName value for.

Return values

bool

setDefaultNamespace() ¶

ConfigResolverInterface.php : 43 Copy path

Changes the default namespace to look parameter into.

public setDefaultNamespace(string $defaultNamespace) : void

Parameters

Name	Type	Default value	Description
$defaultNamespace	string	-	-