eZPublishCommunityProject  2013.4
eZ\Publish\Core\MVC\ConfigResolverInterface Interface Reference

Interface for config resolvers. More...

+ Inheritance diagram for eZ\Publish\Core\MVC\ConfigResolverInterface:

Public Member Functions

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

Detailed Description

Interface for config resolvers.

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 : "<namespace>.<scope>.parameter.name".

Member Function Documentation

eZ\Publish\Core\MVC\ConfigResolverInterface::hasParameter (   $paramName,
  $namespace = null,
  $scope = null 
)

Checks if $paramName exists in $namespace.

Parameters
string$paramName
string$namespaceIf null, the default namespace should be used.
string$scopeThe scope you need $paramName value for.
Returns
boolean

Implemented in eZ\Bundle\EzPublishLegacyBundle\DependencyInjection\Configuration\LegacyConfigResolver, eZ\Bundle\EzPublishCoreBundle\DependencyInjection\Configuration\ConfigResolver, and eZ\Bundle\EzPublishCoreBundle\DependencyInjection\Configuration\ChainConfigResolver.

eZ\Publish\Core\MVC\ConfigResolverInterface::setDefaultNamespace (   $defaultNamespace)

The documentation for this interface was generated from the following file: