AbstractDoctrineExtension
абстрактный класс AbstractDoctrineExtension расширяет Extension
Этот абстрактный класс объединяет общий код, необходимый расширениям Doctrine Object Manager (ORM, MongoDB, CouchDB).
Свойства
| protected | $aliasMap | Используется внутри метода драйвера метаданных для упрощения агрегации данных. | |
| protected | $drivers | Используется внутри метода драйвера метаданных для упрощения агрегации данных. |
Методы
| string | getXsdValidationBasePath() Возвращает базовый путь к файлам XSD. | из Extension |
| string | getNamespace() Возвращает пространство имён, которое следует использовать для этого расширения (пространство имён XML). | из Extension |
| string | getAlias() Возвращает рекомендуемый псевдоним для использования в XML. | из Extension |
| ConfigurationInterface|null | getConfiguration(array $config, ContainerBuilder $container) Возвращает конфигурацию расширения. | из Extension |
| processConfiguration(ConfigurationInterface $configuration, array $configs) | из Extension | |
| getProcessedConfigs() | из Extension | |
| bool | isConfigEnabled(ContainerBuilder $container, array $config) | из Extension |
| array | getAnnotatedClassesToCompile() Получает аннотированные классы для кэширования. | из Extension |
| addAnnotatedClassesToCompile(array $annotatedClasses) Добавляет аннотированные классы в кэш классов. | из Extension | |
| loadMappingInformation(array $objectManager, ContainerBuilder $container) | ||
| setMappingDriverAlias(array $mappingConfig, string $mappingName) Регистрирует псевдоним для этого драйвера отображения. | ||
| setMappingDriverConfig(array $mappingConfig, string $mappingName) Регистрирует конфигурацию драйвера отображения для последующего использования с цепочкой драйверов метаданных менеджеров объектов. | ||
| array|false | getMappingDriverBundleConfigDefaults(array $bundleConfig, ReflectionClass $bundle, ContainerBuilder $container) Если это отображение, управляемое пакетом, вся недостающая информация может быть автоматически обнаружена этим методом. | |
| registerMappingDrivers(array $objectManager, ContainerBuilder $container) Регистрирует всю собранную информацию об отображении в менеджере объектов, зарегистрировав соответствующие драйверы отображения. | ||
| assertValidMappingConfiguration(array $mappingConfig, string $objectManagerName) Проверка, если указанная информация об отображении действительна. | ||
| string|null | detectMetadataDriver(string $dir, ContainerBuilder $container) Обнаруживает, какой драйвер метаданных использовать для предоставленного каталога. | |
| loadObjectManagerCacheDriver(array $objectManager, ContainerBuilder $container, string $cacheName) Загружает настроенный драйвер кэша метаданных, запросов или результатов менеджера объектов. | ||
| string | loadCacheDriver(string $cacheName, string $objectManagerName, array $cacheDriver, ContainerBuilder $container) Загружает драйвер кэша. | |
| array | fixManagersAutoMappings(array $managerConfigs, array $bundles) Возвращает изменённую версию $managerConfigs. | |
| string | getObjectManagerElementName(string $name) Добавляет префикс пути к контейнеру зависимостей с относительным значением к префиксу менеджера объектов. | |
| string | getMappingObjectDefaultName() Существительное, описывающее сопоставленные объекты, такие как сущность или документ. | |
| string | getMappingResourceConfigDirectory() Относительный путь от корня пакета к каталогу, где находятся файлы отображения. | |
| string | getMappingResourceExtension() Расширение, используемое файлами отображения. |
Подробности
строка 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 |
final protected processConfiguration(ConfigurationInterface $configuration, array $configs)
Параметры
| ConfigurationInterface | $configuration | |
| массив | $configs |
final getProcessedConfigs()
protected bool isConfigEnabled(ContainerBuilder $container, array $config)
Параметры
| ContainerBuilder | $container | |
| массив | $config |
Значение возврата
| bool | Включена ли конфигурация |
Исключения
| InvalidArgumentException | При невозможной проверке включения конфигурации |
массив getAnnotatedClassesToCompile()
Получает аннотированные классы для кэширования.
Значение возврата
| массив | Массив классов |
addAnnotatedClassesToCompile(array $annotatedClasses)
Добавляет аннотированные классы в кэш классов.
Параметры
| массив | $annotatedClasses | Массив шаблонов классов |
protected loadMappingInformation(array $objectManager, ContainerBuilder $container)
Параметры
| массив | $objectManager | Настроенный менеджер объектов |
| ContainerBuilder | $container | Экземпляр ContainerBuilder |
Исключения
| InvalidArgumentException |
protected setMappingDriverAlias(array $mappingConfig, string $mappingName)
Регистрирует псевдоним для данного драйвера сопоставления.
Псевдонимы могут использоваться в языках запросов всех менеджеров объектов Doctrine для упрощения написания задач.
Параметры
| массив | $mappingConfig | |
| строка | $mappingName |
protected setMappingDriverConfig(array $mappingConfig, string $mappingName)
Регистрирует конфигурацию драйвера сопоставления для последующего использования с цепочкой драйверов метаданных менеджеров объектов.
Параметры
| массив | $mappingConfig | |
| строка | $mappingName |
Исключения
| InvalidArgumentException |
protected массив|false getMappingDriverBundleConfigDefaults(array $bundleConfig, ReflectionClass $bundle, ContainerBuilder $container)
Если это сопоставление, управляемое пакетом, вся недостающая информация может быть автоматически обнаружена этим методом.
Возвращает false, если автоматическое обнаружение не удалось, в противном случае массив с завершённой информацией.
Параметры
| массив | $bundleConfig | |
| ReflectionClass | $bundle | |
| ContainerBuilder | $container |
Значение возврата
| массив|false |
protected registerMappingDrivers(array $objectManager, ContainerBuilder $container)
Регистрирует всю собранную информацию о сопоставлении в менеджере объектов, зарегистрировав соответствующие драйверы сопоставления.
Параметры
| массив | $objectManager | |
| ContainerBuilder | $container | Экземпляр ContainerBuilder |
protected assertValidMappingConfiguration(array $mappingConfig, string $objectManagerName)
Проверка, является ли указанная информация о сопоставлении корректной.
Параметры
| массив | $mappingConfig | |
| строка | $objectManagerName |
Исключения
| InvalidArgumentException |
protected строка|null detectMetadataDriver(string $dir, ContainerBuilder $container)
Обнаруживает драйвер метаданных для предоставленного каталога.
Параметры
| строка | $dir | Путь к каталогу |
| ContainerBuilder | $container | Экземпляр ContainerBuilder |
Значение возврата
| строка|null | Короткое имя драйвера метаданных, если оно было обнаружено |
protected loadObjectManagerCacheDriver(array $objectManager, ContainerBuilder $container, string $cacheName)
Загружает настроенные метаданные менеджера объектов, кэш запросов или результатов.
Параметры
| массив | $objectManager | Настроенный менеджер объектов |
| ContainerBuilder | $container | Экземпляр ContainerBuilder |
| строка | $cacheName |
Исключения
| InvalidArgumentException | в случае неизвестного типа драйвера |
protected строка loadCacheDriver(string $cacheName, string $objectManagerName, array $cacheDriver, ContainerBuilder $container)
Загружает драйвер кэша.
Параметры
| string | $cacheName | Имя драйвера кэша |
| string | $objectManagerName | Имя менеджера объектов |
| array | $cacheDriver | Сопоставление драйверов кэша |
| ContainerBuilder | $container | Экземпляр ContainerBuilder |
Значение результата
| string |
Исключения
| InvalidArgumentException |
protected array fixManagersAutoMappings(array $managerConfigs, array $bundles)
Возвращает изменённую версию $managerConfigs.
Менеджер с именем $autoMappedManager будет сопоставлять все пакеты, которые не сопоставлены другими менеджерами.
Параметры
| array | $managerConfigs | |
| array | $bundles |
Значение результата
| array | Изменённая версия $managerConfigs |
abstract protected string getObjectManagerElementName(string $name)
Добавляет префикс пути к контейнеру зависимостей с префиксом менеджера объектов.
Параметры
| string | $name |
Значение результата
| string |
abstract protected string getMappingObjectDefaultName()
Существительное, описывающее сопоставленные объекты, такие как Entity или Document.
Будет использоваться для автоматического определения каталога постоянных объектов.
Значение результата
| string |
abstract protected string getMappingResourceConfigDirectory()
Относительный путь от корня пакета к каталогу, где находятся файлы сопоставления.
Значение результата
| string |
abstract protected string getMappingResourceExtension()
Расширение, используемое файлами сопоставления.
Значение результата
| string |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Bridge/Doctrine/DependencyInjection/AbstractDoctrineExtension.html