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 |
| setProperties(array $properties) | из Definition | |
| getProperties() | из Definition | |
| setProperty($name, $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 |
| 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 | 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) устарело Устанавливает типы, которые по умолчанию будут ссылаться на это определение. | из Definition |
| bool | isAutowired() Является ли определение автозависимым? | из Definition |
| $this | setAutowired(bool $autowired) Включает/отключает автозависимость. | из Definition |
| string[] | getAutowiringTypes() устарело Возвращает типы автозависимости, которые по умолчанию будут ссылаться на это определение. | из Definition |
| $this | addAutowiringType(string $type) устарело Добавляет тип, который по умолчанию будет ссылаться на это определение. | из Definition |
| $this | removeAutowiringType(string $type) устарело Удаляет тип. | из Definition |
| bool | hasAutowiringType(string $type) устарело Будет ли это определение по умолчанию для данного типа? | из Definition |
| string | getParent() Возвращает определение, от которого наследуется. | |
| $this | setParent(string $parent) Устанавливает определение, от которого наследуется. |
Подробности
__construct(string $parent)
Параметры
| string | $parent | Идентификатор экземпляра Definition, который нужно декорировать |
array getChanges()
Возвращает все отслеживаемые изменения для объекта Definition.
Значение результата
| array | Массив изменений для данного объекта Definition |
$this setChanges(array $changes)
Устанавливает отслеживаемые изменения для объекта Definition.
Параметры
| array | $changes |
Значение результата
| $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 |
setProperties(array $properties)
Параметры
| array | $properties |
getProperties()
setProperty($name, $value)
Параметры
| $name | ||
| $value |
$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 | Массив вызовов методов |
setInstanceofConditionals(array $instanceof)
Параметры
| array | $instanceof | ChildDefinition[] |
ChildDefinition[] getInstanceofConditionals()
Получает шаблоны определений, которые должны быть применены к текущему определению условно, индексированные по родительскому интерфейсу/классу.
Значение результата
| ChildDefinition[] |
$this setAutoconfigured(bool $autoconfigured)
Параметры
| bool | $autoconfigured |
Значение результата
| $this |
bool isAutoconfigured()
Значение результата
| bool |
$this setTags(array $tags)
Устанавливает теги для этого определения.
Параметры
| array | $tags |
Значение результата
| $this |
array getTags()
Возвращает все теги.
Значение результата
| массив | Массив тегов |
массив getTag(строка $name)
Получает тег по имени.
Параметры
| строка | $name | Имя тега |
Возвращаемое значение
| массив | Массив атрибутов |
$this addTag(строка $name, массив $attributes = массив())
Добавляет тег для этого определения.
Параметры
| строка | $name | Имя тега |
| массив | $attributes | Массив атрибутов |
Возвращаемое значение
| $this |
bool hasTag(строка $name)
Указывает, содержит ли это определение тег с заданным именем.
Параметры
| строка | $name |
Возвращаемое значение
| bool |
$this clearTag(строка $name)
Очищает все теги для данного имени.
Параметры
| строка | $name | Имя тега |
Возвращаемое значение
| $this |
$this clearTags()
Очищает теги для этого определения.
Возвращаемое значение
| $this |
$this setFile(строка $file)
Устанавливает файл, который необходимо включить перед созданием сервиса.
Параметры
| строка | $file | Полный путь к файлу для включения |
Возвращаемое значение
| $this |
строка|null getFile()
Получает файл, который необходимо включить перед созданием сервиса.
Возвращаемое значение
| строка|null | Полный путь к файлу для включения |
$this setShared(bool $shared)
Устанавливает, должен ли сервис быть общим или нет.
Параметры
| bool | $shared | Необходимо ли использовать общий сервис |
Возвращаемое значение
| $this |
bool isShared()
Является ли этот сервис общим.
Возвращаемое значение
| bool |
$this setPublic(bool $boolean)
Устанавливает видимость этого сервиса.
Параметры
| bool | $boolean |
Возвращаемое значение
| $this |
bool isPublic()
Является ли этот сервис публичным.
Возвращаемое значение
| 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 | |
| строка | $template | Сообщение шаблона для использования, если определение устарело |
Возвращаемое значение
| $this |
Исключения
| InvalidArgumentException | При некорректном шаблоне сообщения. |
bool isDeprecated()
Является ли это определение устаревшим, то есть больше не должно вызываться.
Возвращаемое значение
| bool |
строка getDeprecationMessage(строка $id)
Сообщение для использования, если это определение устарело.
Параметры
| строка | $id | Идентификатор сервиса, использующего это определение |
Возвращаемое значение
| строка |
$this setConfigurator(строка|массив $configurator)
Устанавливает конфигуратор для вызова после полного инициализации сервиса.
Параметры
| строка|массив | $configurator | PHP вызываемый объект |
Возвращаемое значение
| $this |
вызываемый объект|null getConfigurator()
Получает конфигуратор для вызова после полного инициализации сервиса.
Возвращаемое значение
| вызываемый объект|null | PHP вызываемый объект |
$this setAutowiringTypes(массив $types) устарело
устарело
Устанавливает типы, которые по умолчанию будут использовать это определение.
Параметры
| массив | $types |
Возвращаемое значение
| $this |
bool isAutowired()
Используется ли автоподключение для этого определения?
Возвращаемое значение
| bool |
$this setAutowired(bool $autowired)
Включает/выключает автоподключение.
Параметры
| bool | $autowired |
Возвращаемое значение
| $this |
строка[] getAutowiringTypes() устарело
устарело
Получает типы автоподключения, которые по умолчанию будут использовать это определение.
Возвращаемое значение
| строка[] |
$this addAutowiringType(строка $type) устарело
устарело
Добавляет тип, который по умолчанию будет использовать это определение.
Параметры
| строка | $type |
Возвращаемое значение
| $this |
$this removeAutowiringType(строка $type) устарело
устарело
Удаляет тип.
Параметры
| строка | $type |
Возвращаемое значение
| $this |
bool hasAutowiringType(строка $type) устарело
устарело
Будет ли это определение по умолчанию для данного типа?
Параметры
| строка | $type |
Возвращаемое значение
| bool |
строка getParent()
Возвращает определение, от которого нужно унаследовать.
Значение возврата
| string |
$this setParent(string $parent)
Устанавливает определение, от которого нужно унаследовать.
Параметры
| string | $parent |
Значение возврата
| $this |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.3/Symfony/Component/DependencyInjection/ChildDefinition.html