PHP Класс eZ\Bundle\EzPublishCoreBundle\DependencyInjection\Configuration\ConfigResolver

This is useful to get a setting for a specific siteaccess for example. It will 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". - is the namespace for your dynamic setting. Defaults to "ezsettings", but can be anything. - is basically the siteaccess name you want your parameter value to apply to. Can also be "global" for a global override. Another scope is used internally: "default". This is the generic fallback. The resolve scope order is the following: 1. "global" 2. SiteAccess name 3. "default"
Наследование: implements eZ\Publish\Core\MVC\Symfony\Configuration\VersatileScopeInterface, implements eZ\Publish\Core\MVC\Symfony\SiteAccess\SiteAccessAware, implements Symfony\Component\DependencyInjection\ContainerAwareInterface, use trait Symfony\Component\DependencyInjection\ContainerAwareTrait
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$defaultNamespace string
$defaultScope string
$groupsBySiteAccess Siteaccess groups, indexed by siteaccess name
$siteAccess eZ\Publish\Core\MVC\Symfony\SiteAccess
$undefinedStrategy integer

Открытые методы

Метод Описание
__construct ( array $groupsBySiteAccess, string $defaultNamespace, integer $undefinedStrategy = self::UNDEFINED_STRATEGY_EXCEPTION )
getDefaultNamespace ( ) : string
getDefaultScope ( )
getParameter ( string $paramName, string $namespace = null, string $scope = null ) : mixed Returns value for $paramName, in $namespace.
getUndefinedStrategy ( ) : integer
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.
setDefaultScope ( $scope )
setSiteAccess ( SiteAccess $siteAccess = null )
setUndefinedStrategy ( integer $undefinedStrategy ) Sets the strategy to use if an undefined parameter is being asked.

Описание методов

__construct() публичный Метод

public __construct ( array $groupsBySiteAccess, string $defaultNamespace, integer $undefinedStrategy = self::UNDEFINED_STRATEGY_EXCEPTION )
$groupsBySiteAccess array SiteAccess groups, indexed by siteaccess.
$defaultNamespace string The default namespace
$undefinedStrategy integer Strategy to use when encountering undefined parameters. Must be one of - ConfigResolver::UNDEFINED_STRATEGY_EXCEPTION (throw an exception) - ConfigResolver::UNDEFINED_STRATEGY_NULL (return null)

getDefaultNamespace() публичный Метод

public getDefaultNamespace ( ) : string
Результат string

getDefaultScope() публичный Метод

public getDefaultScope ( )

getParameter() публичный Метод

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 will be used.
$scope string The scope you need $paramName value for. It's typically the siteaccess name. If null, the current siteaccess name will be used.
Результат mixed

getUndefinedStrategy() публичный Метод

public getUndefinedStrategy ( ) : integer
Результат integer

hasParameter() публичный Метод

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. It's typically the siteaccess name. If null, the current siteaccess name will be used.
Результат boolean

setDefaultNamespace() публичный Метод

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

setDefaultScope() публичный Метод

public setDefaultScope ( $scope )

setSiteAccess() публичный Метод

public setSiteAccess ( SiteAccess $siteAccess = null )
$siteAccess eZ\Publish\Core\MVC\Symfony\SiteAccess

setUndefinedStrategy() публичный Метод

Can be one of: - ConfigResolver::UNDEFINED_STRATEGY_EXCEPTION (throw an exception) - ConfigResolver::UNDEFINED_STRATEGY_NULL (return null). Defaults to ConfigResolver::UNDEFINED_STRATEGY_EXCEPTION.
public setUndefinedStrategy ( integer $undefinedStrategy )
$undefinedStrategy integer

Описание свойств

$defaultNamespace защищенное свойство

protected string $defaultNamespace
Результат string

$defaultScope защищенное свойство

protected string $defaultScope
Результат string

$groupsBySiteAccess защищенное свойство

Siteaccess groups, indexed by siteaccess name
protected $groupsBySiteAccess

$siteAccess защищенное свойство

protected SiteAccess,eZ\Publish\Core\MVC\Symfony $siteAccess
Результат eZ\Publish\Core\MVC\Symfony\SiteAccess

$undefinedStrategy защищенное свойство

protected int $undefinedStrategy
Результат integer