ChildDefinition
class ChildDefinition extends Definition
Это определение расширяет другое определение.
Методы
| __construct(string $parent) | ||
| массив | getChanges() Возвращает все отслеживаемые изменения для объекта Definition. | из Definition |
| $this | setChanges(array $changes) Устанавливает отслеживаемые изменения для объекта Definition. | из Definition |
| $this | setFactory(string|array $factory) Устанавливает фабрику. | из Definition |
| строка|массив | getFactory() Получает фабрику. | из Definition |
| $this | setDecoratedService(null|string $id, null|string $renamedId = null, int $priority) Устанавливает сервис, который этот сервис декорирует. | из Definition |
| null|массив | getDecoratedService() Получает сервис, который этот сервис декорирует. | из Definition |
| $this | setClass(string $class) Устанавливает класс сервиса. | из Definition |
| строка|null | getClass() Получает класс сервиса. | из Definition |
| $this | setArguments(array $arguments) Устанавливает аргументы для передачи конструктору/методу фабрики сервиса. | из Definition |
| $this | setProperties(array $properties) Устанавливает свойства для определения при создании сервиса. | из Definition |
| массив | getProperties() Получает свойства для определения при создании сервиса. | из Definition |
| $this | setProperty(string $name, mixed $value) Устанавливает конкретное свойство. | из Definition |
| $this | addArgument(mixed $argument) Добавляет аргумент для передачи конструктору/методу фабрики сервиса. | из Definition |
| $this | replaceArgument(int|string $index, mixed $value) Всегда используйте этот метод при перезаписи существующих аргументов родительского определения. | |
| $this | setArgument(int|string $key, mixed $value) Устанавливает конкретный аргумент. | из Definition |
| массив | getArguments() Получает аргументы для передачи конструктору/методу фабрики сервиса. | из Definition |
| смешанный | getArgument(int|string $index) Получает аргумент для передачи конструктору/методу фабрики сервиса. | |
| $this | setMethodCalls(array $calls = array()) Устанавливает методы, которые нужно вызвать после инициализации сервиса. | из Definition |
| $this | addMethodCall(string $method, array $arguments = array()) Добавляет метод, который нужно вызвать после инициализации сервиса. | из Definition |
| $this | removeMethodCall(string $method) Удаляет метод, который нужно вызвать после инициализации сервиса. | из Definition |
| bool | hasMethodCall(string $method) Проверяет, содержит ли текущее определение заданный метод для вызова после инициализации сервиса. | из Definition |
| массив | getMethodCalls() Получает методы, которые нужно вызвать после инициализации сервиса. | из Definition |
| $this | setInstanceofConditionals(array $instanceof) | |
| ChildDefinition[] | getInstanceofConditionals() Получает шаблоны определений, которые нужно применить к текущему определению условно, по ключу родительский интерфейс/класс. | из Definition |
| $this | setAutoconfigured(bool $autoconfigured) | |
| bool | isAutoconfigured() | из Definition |
| $this | setTags(array $tags) Устанавливает теги для этого определения. | из Definition |
| массив | getTags() Возвращает все теги. | из Definition |
| массив | getTag(string $name) Получает тег по имени. | из Definition |
| $this | addTag(string $name, array $attributes = array()) Добавляет тег для этого определения. | из Definition |
| bool | hasTag(string $name) Является ли у этого определения тег с заданным именем. | из Definition |
| $this | clearTag(string $name) Очищает все теги для данного имени. | из Definition |
| $this | clearTags() Очищает теги для этого определения. | из Definition |
| $this | setFile(string $file) Устанавливает файл, который необходимо загрузить перед созданием сервиса. | из Definition |
| строка|null | getFile() Получает файл, который необходимо загрузить перед созданием сервиса. | из Definition |
| $this | setShared(bool $shared) Устанавливает, должен ли сервис быть общим или нет. | из Definition |
| bool | isShared() Является ли этот сервис общим. | из Definition |
| $this | setPublic(bool $boolean) Устанавливает видимость этого сервиса. | из Definition |
| bool | isPublic() Является ли этот сервис публичным. | из Definition |
| $this | setPrivate(bool $boolean) Устанавливает, является ли этот сервис приватным. | из Definition |
| bool | isPrivate() Является ли этот сервис приватным. | из Definition |
| $this | setLazy(bool $lazy) Устанавливает флаг ленивости этого сервиса. | из Definition |
| bool | isLazy() Является ли этот сервис ленивым. | из Definition |
| $this | setSynthetic(bool $boolean) Устанавливает, является ли данное определение синтетическим, то есть не создаётся контейнером, а вводится динамически. | из Definition |
| bool | isSynthetic() Является ли данное определение синтетическим, то есть не создаётся контейнером, а вводится динамически. | из Definition |
| $this | setAbstract(bool $boolean) Является ли данное определение абстрактным, то есть служит лишь шаблоном для других определений. | из Definition |
| bool | isAbstract() Является ли данное определение абстрактным, то есть служит лишь шаблоном для других определений. | из Definition |
| $this | setDeprecated(bool $status = true, string $template = null) Является ли данное определение устаревшим, то есть больше не должно вызываться. | из Definition |
| bool | isDeprecated() Является ли данное определение устаревшим, то есть больше не должно вызываться. | из Definition |
| string | getDeprecationMessage(string $id) Сообщение, используемое, если данное определение устарело. | из Definition |
| $this | setConfigurator(string|array $configurator) Устанавливает конфигуратор, вызываемый после полного инициализации сервиса. | из Definition |
| callable|null | getConfigurator() Получает конфигуратор, вызываемый после полного инициализации сервиса. | из Definition |
| $this | setAutowiringTypes(array $types) deprecated Устанавливает типы, которые будут по умолчанию использовать это определение. | из Definition |
| bool | isAutowired() Используется ли автоматическое подключение для определения? | из Definition |
| $this | setAutowired(bool $autowired) Включает/выключает автоматическое подключение. | из Definition |
| string[] | getAutowiringTypes() deprecated Получает типы автоматического подключения, которые по умолчанию будут использовать это определение. | из Definition |
| $this | addAutowiringType(string $type) deprecated Добавляет тип, который будет по умолчанию использовать это определение. | из Definition |
| $this | removeAutowiringType(string $type) deprecated Удаляет тип. | из Definition |
| bool | hasAutowiringType(string $type) deprecated Будет ли это определение использоваться по умолчанию для данного типа? | из Definition |
| array | getBindings() Получает привязки. | из Definition |
| $this | setBindings(array $bindings) | |
| string | getParent() Возвращает определение, от которого нужно унаследовать. | |
| $this | setParent(string $parent) Устанавливает определение, от которого нужно унаследовать. |
Подробности
__construct(string $parent)
Параметры
| string | $parent | Идентификатор экземпляра Definition, который необходимо декорировать |
array getChanges()
Возвращает все отслеживаемые изменения для объекта Definition.
Значение результата
| array | Массив изменений для этого объекта Definition |
$this setChanges(array $changes)
Устанавливает отслеживаемые изменения для объекта Definition.
Параметры
| array | $changes | Массив изменений для этого объекта Definition |
Значение результата
| $this |
$this setFactory(string|array $factory)
Устанавливает фабрику.
Параметры
| string|array | $factory | Функция PHP или массив, содержащий класс/ссылку и метод для вызова |
Значение результата
| $this |
string|array getFactory()
Получает фабрику.
Значение результата
| string|array | Функция PHP или массив, содержащий класс/ссылку и метод для вызова |
$this setDecoratedService(null|string $id, null|string $renamedId = null, int $priority)
Устанавливает сервис, который декорируется этим сервисом.
Параметры
| null|string | $id | Идентификатор декорируемого сервиса, используйте null для удаления декорирования |
| null|string | $renamedId | Новый идентификатор декорируемого сервиса |
| int | $priority | Приоритет декорирования |
Значение результата
| $this |
Исключения
| InvalidArgumentException | в случае, если идентификаторы декорируемого сервиса и нового декорируемого сервиса совпадают |
null|array getDecoratedService()
Получает сервис, который декорируется этим сервисом.
Значение результата
| null|array | Массив, состоящий из идентификатора декорируемого сервиса, нового идентификатора и приоритета декорирования; null, если сервис не декорируется |
$this setClass(string $class)
Устанавливает класс сервиса.
Параметры
| string | $class | Класс сервиса |
Значение результата
| $this |
string|null getClass()
Получает класс сервиса.
Значение результата
| string|null | Класс сервиса |
$this setArguments(array $arguments)
Устанавливает аргументы для передачи конструктору/методу-фабрике сервиса.
Параметры
| array | $arguments | Массив аргументов |
Значение результата
| $this |
$this setProperties(array $properties)
Устанавливает свойства, которые необходимо определить при создании сервиса.
Параметры
| array | $properties |
Значение результата
| $this |
array getProperties()
Получает свойства, которые необходимо определить при создании сервиса.
Значение результата
| array |
$this setProperty(string $name, mixed $value)
Устанавливает определенное свойство.
Параметры
| string | $name | |
| mixed | $value |
Значение результата
| $this |
$this addArgument(mixed $argument)
Добавляет аргумент для передачи конструктору/методу-фабрике сервиса.
Параметры
| mixed | $argument | Аргумент |
Значение результата
| $this |
$this replaceArgument(int|string $index, mixed $value)
В этом методе всегда необходимо использовать замену существующих аргументов родительского определения.
Если вы напрямую вызываете setArguments(), имейте в виду, что необходимо соблюдать определенные соглашения, когда вы хотите заменить аргументы родительского определения; в противном случае ваши аргументы будут добавлены в конец.
Параметры
| int|string | $index | |
| mixed | $value |
Значение результата
| $this |
Исключения
| InvalidArgumentException | если $index не является целым числом |
$this setArgument(int|string $key, mixed $value)
Устанавливает определенный аргумент.
Параметры
| int|string | $key | |
| mixed | $value |
Значение результата
| $this |
array getArguments()
Получает аргументы для передачи конструктору/методу-фабрике сервиса.
Значение результата
| array | Массив аргументов |
mixed getArgument(int|string $index)
Получает аргумент для передачи конструктору/методу-фабрике сервиса.
Если для замены аргумента использовался replaceArgument(), этот метод вернет значение замены.
Параметры
| int|string | $index |
Значение результата
| mixed | Значение аргумента |
Исключения
| OutOfBoundsException | При отсутствии аргумента |
$this setMethodCalls(array $calls = array())
Устанавливает методы для вызова после инициализации сервиса.
Параметры
| array | $calls | Массив вызовов методов |
Значение результата
| $this |
$this addMethodCall(string $method, array $arguments = array())
Добавляет метод для вызова после инициализации сервиса.
Параметры
| string | $method | Имя вызываемого метода |
| array | $arguments | Массив аргументов для передачи в вызов метода |
Значение результата
| $this |
Исключения
| InvalidArgumentException | при пустом параметре $method |
$this removeMethodCall(string $method)
Удаляет метод для вызова после инициализации сервиса.
Параметры
| string | $method | Имя метода для удаления |
Значение результата
| $this |
bool hasMethodCall(string $method)
Проверяет, содержит ли текущее определение указанный метод для вызова после инициализации сервиса.
Параметры
| string | $method | Имя метода для поиска |
Значение результата
| bool |
array getMethodCalls()
Получает методы для вызова после инициализации сервиса.
Значение результата
| array | Массив вызовов методов |
$this setInstanceofConditionals(array $instanceof)
Параметры
| array | $instanceof | ChildDefinition[] |
Значение результата
| $this |
ChildDefinition[] getInstanceofConditionals()
Получает шаблоны определений для условного применения к текущему определению, индексированные по родительскому интерфейсу/классу.
Значение результата
| ChildDefinition[] |
$this setAutoconfigured(bool $autoconfigured)
Параметры
| bool | $autoconfigured |
Значение результата
| $this |
bool isAutoconfigured()
Значение возврата
| bool |
$this setTags(array $tags)
Устанавливает теги для данного определения.
Параметры
| array | $tags |
Значение возврата
| $this |
array getTags()
Возвращает все теги.
Значение возврата
| array | Массив тегов |
array getTag(string $name)
Получает тег по имени.
Параметры
| string | $name | Имя тега |
Значение возврата
| array | Массив атрибутов |
$this addTag(string $name, array $attributes = array())
Добавляет тег для данного определения.
Параметры
| string | $name | Имя тега |
| array | $attributes | Массив атрибутов |
Значение возврата
| $this |
bool hasTag(string $name)
Является ли данное определение тегом с данным именем.
Параметры
| string | $name |
Значение возврата
| bool |
$this clearTag(string $name)
Очищает все теги для данного имени.
Параметры
| string | $name | Имя тега |
Значение возврата
| $this |
$this clearTags()
Очищает теги для данного определения.
Значение возврата
| $this |
$this setFile(string $file)
Устанавливает файл, который необходимо подключить перед созданием сервиса.
Параметры
| string | $file | Полный путь к файлу для включения |
Значение возврата
| $this |
string|null getFile()
Получает файл, который необходимо подключить перед созданием сервиса.
Значение возврата
| string|null | Полный путь к файлу для включения |
$this setShared(bool $shared)
Устанавливает, должен ли сервис быть общим или нет.
Параметры
| bool | $shared | Требуется ли общий доступ к сервису |
Значение возврата
| $this |
bool isShared()
Является ли данный сервис общим.
Значение возврата
| bool |
$this setPublic(bool $boolean)
Устанавливает видимость данного сервиса.
Параметры
| bool | $boolean |
Значение возврата
| $this |
bool isPublic()
Является ли этот сервис доступным для всех.
Значение возврата
| bool |
$this setPrivate(bool $boolean)
Устанавливает, является ли этот сервис закрытым.
При установке состояние "private" имеет больший приоритет, чем "public". В версии 3.4 закрытый сервис всегда остаётся доступным для всех, но при обращении к контейнеру выводится сообщение о устаревании, чтобы в версии 4.0 сервис можно было сделать действительно закрытым.
Параметры
| bool | $boolean |
Значение возврата
| $this |
bool isPrivate()
Является ли этот сервис закрытым.
Значение возврата
| bool |
$this setLazy(bool $lazy)
Устанавливает флаг лени для данного сервиса.
Параметры
| bool | $lazy |
Значение возврата
| $this |
bool isLazy()
Является ли этот сервис ленивым.
Значение возврата
| bool |
$this setSynthetic(bool $boolean)
Устанавливает, является ли данное определение синтетическим, то есть не создаётся контейнером, а вводится динамически.
Параметры
| bool | $boolean |
Значение возврата
| $this |
bool isSynthetic()
Является ли данное определение синтетическим, то есть не создаётся контейнером, а вводится динамически.
Значение возврата
| bool |
$this setAbstract(bool $boolean)
Является ли данное определение абстрактным, то есть оно служит лишь шаблоном для других определений.
Параметры
| bool | $boolean |
Значение возврата
| $this |
bool isAbstract()
Является ли данное определение абстрактным, то есть оно служит лишь шаблоном для других определений.
Значение возврата
| bool |
$this setDeprecated(bool $status = true, string $template = null)
Является ли данное определение устаревшим, то есть больше не должно вызываться.
Параметры
| bool | $status | |
| string | $template | Сообщение шаблона, используемое, если определение устарело |
Значение возврата
| $this |
Исключения
| InvalidArgumentException | при некорректном шаблоне сообщения |
bool isDeprecated()
Является ли данное определение устаревшим, то есть больше не должно вызываться.
Значение возврата
| bool |
string getDeprecationMessage(string $id)
Сообщение, используемое, если данное определение устарело.
Параметры
| string | $id | Идентификатор сервиса, зависящего от данного определения |
Значение возврата
| string |
$this setConfigurator(string|array $configurator)
Устанавливает конфигуратор, который вызывается после полного инициализации сервиса.
Параметры
| string|array | $configurator | PHP вызываемый объект |
Значение возврата
| $this |
callable|null getConfigurator()
Получает конфигуратор, который вызывается после полного инициализации сервиса.
Значение возврата
| callable|null | PHP вызываемый объект |
$this setAutowiringTypes(array $types) устарело
устарело
Устанавливает типы, которые будут по умолчанию ссылаться на это определение.
Параметры
| array | $types |
Значение возврата
| $this |
bool isAutowired()
Является ли определение автоматизированным?
Значение возврата
| bool |
$this setAutowired(bool $autowired)
Включает/выключает автоматизацию.
Параметры
| bool | $autowired |
Значение возврата
| $this |
string[] getAutowiringTypes() устарело
устарело
Получает типы автоматизации, которые будут по умолчанию ссылаться на это определение.
Значение возврата
| string[] |
$this addAutowiringType(string $type) устарело
устарело
Добавляет тип, который будет по умолчанию ссылаться на это определение.
Параметры
| строка | $type |
Значение возвращаемого значения
| $this |
$this removeAutowiringType(string $type) устаревший
устаревший
Удаляет тип.
Параметры
| строка | $type |
Значение возвращаемого значения
| $this |
bool hasAutowiringType(string $type) устаревший
устаревший
Будет ли это определение по умолчанию для данного типа?
Параметры
| строка | $type |
Значение возвращаемого значения
| bool |
array getBindings()
Получает привязки.
Значение возвращаемого значения
| массив |
$this setBindings(array $bindings)
Параметры
| массив | $bindings |
Значение возвращаемого значения
| $this |
string getParent()
Возвращает определение для наследования.
Значение возвращаемого значения
| строка |
$this setParent(string $parent)
Устанавливает определение для наследования.
Параметры
| строка | $parent |
Значение возвращаемого значения
| $this |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.4/Symfony/Component/DependencyInjection/ChildDefinition.html