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