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