ConfigurableExtension
class ConfigurableExtension extends Extension
Этот подкласс расширения обеспечивает первоклассную интеграцию с компонентом Config/Definition.
Вы можете использовать его в качестве базового класса, если:
a) вы используете компонент Config/Definition для конфигурации, b) ваш класс конфигурации называется "Configuration", и c) класс конфигурации находится в подпапке DependencyInjection.
Методы
| string | getXsdValidationBasePath() Возвращает базовый путь к файлам XSD. | from Extension |
| string | getNamespace() Возвращает имя пространства имён, которое следует использовать для этого расширения (пространство имён XML). | from Extension |
| string | getAlias() Возвращает рекомендуемый псевдоним для использования в XML. | from Extension |
| ConfigurationInterface|null | getConfiguration(array $config, ContainerBuilder $container) Возвращает конфигурацию расширения. | from Extension |
| array | getClassesToCompile() Получает классы для кэширования. | from Extension |
| addClassesToCompile(array $classes) Добавляет классы в кэш классов. | from Extension | |
| load(array $configs, ContainerBuilder $container) Загружает определенную конфигурацию. |
Подробное описание
string getXsdValidationBasePath()
Возвращает базовый путь к файлам XSD.
Возвращаемое значение
| string | Базовый путь к файлам XSD |
string getNamespace()
Возвращает имя пространства имён, которое следует использовать для этого расширения (пространство имён XML).
Возвращаемое значение
| string | Пространство имён XML |
string getAlias()
Возвращает рекомендуемый псевдоним для использования в XML.
Этот псевдоним также является обязательным префиксом для использования в YAML.
Эта конвенция заключается в удалении суффикса "Extension" из имени класса, а затем приведении результата к нижнему регистру и замене пробелов на подчеркивания. Например:
AcmeHelloExtension
становится
acme_hello
Это можно переопределить в подклассе, чтобы указать псевдоним вручную.
Возвращаемое значение
| string | Псевдоним |
Исключения
| BadMethodCallException | При несоответствии имени расширения соглашениям |
ConfigurationInterface|null getConfiguration(array $config, ContainerBuilder $container)
Возвращает конфигурацию расширения.
Параметры
| array | $config | Массив значений конфигурации |
| ContainerBuilder | $container | Экземпляр ContainerBuilder |
Возвращаемое значение
| ConfigurationInterface|null | Конфигурация или null |
array getClassesToCompile()
Получает классы для кэширования.
Возвращаемое значение
| array | Массив классов |
addClassesToCompile(array $classes)
Добавляет классы в кэш классов.
Параметры
| array | $classes | Массив классов |
final load(array $configs, ContainerBuilder $container)
Загружает определенную конфигурацию.
Параметры
| array | $configs | |
| ContainerBuilder | $container | Экземпляр ContainerBuilder |
Исключения
| InvalidArgumentException | При указании тега, который не определён в этом расширении |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/HttpKernel/DependencyInjection/ConfigurableExtension.html
