DefinitionDecorator
класс DefinitionDecorator расширяет Definition
Это определение декорирует другое определение.
Методы
| __construct(string $parent) | ||
| $this | setFactory($callable) Устанавливает фабрику. | |
| string|array | getFactory() Получает фабрику. | из Definition |
| $this | setFactoryClass($class) Устанавливает имя класса, который действует как фабрика, используя метод фабрики, который будет вызываться статически. | |
| string|null | getFactoryClass($triggerDeprecationError = true) устаревшее Получает класс фабрики. | из Definition |
| $this | setFactoryMethod($method) Устанавливает метод фабрики, способный создать экземпляр этого класса. | |
| $this | setDecoratedService(null|string $id, null|string $renamedId = null) Устанавливает сервис, который декорирует этот сервис. | |
| null|array | getDecoratedService() Получает сервис, который декорирует этот сервис. | из Definition |
| string|null | getFactoryMethod($triggerDeprecationError = true) устаревшее Получает метод фабрики. | из Definition |
| $this | setFactoryService($service, $triggerDeprecationError = true) Устанавливает имя сервиса, который действует как фабрика, используя метод фабрики. | |
| string|null | getFactoryService($triggerDeprecationError = true) устаревшее Получает идентификатор сервиса-фабрики. | из Definition |
| $this | setClass(string $class) Устанавливает класс сервиса. | |
| string|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 $index, mixed $value) В этом методе необходимо использовать при перезаписи существующих аргументов родительского определения. | |
| array | getArguments() Получает аргументы для передачи конструктору сервиса/методу фабрики. | из Definition |
| mixed | getArgument(int $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 |
| array | getMethodCalls() Получает методы для вызова после инициализации сервиса. | из Definition |
| $this | setTags(array $tags) Устанавливает метки для этого определения. | из Definition |
| array | getTags() Возвращает все метки. | из Definition |
| array | 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) Устанавливает файл для включения перед созданием сервиса. | |
| string|null | getFile() Получает файл для включения перед созданием сервиса. | из Definition |
| $this | setScope(string $scope) Устанавливает область сервиса. | из Definition |
| string | getScope() Возвращает область сервиса. | из Definition |
| $this | setPublic(bool $boolean) Устанавливает видимость этого сервиса. | |
| bool | isPublic() Указывает, является ли этот сервис публичным. | из Definition |
| $this | setSynchronized($boolean, $triggerDeprecationError = true) устаревшее Устанавливает флаг синхронизации этого сервиса. | из Definition |
| bool | isSynchronized($triggerDeprecationError = true) устаревшее Указывает, является ли этот сервис синхронизированным. | из Definition |
| $this | setLazy($boolean) Устанавливает флаг ленивого выполнения этого сервиса. | |
| bool | isLazy() Указывает, является ли этот сервис ленивым. | из Definition |
| $this | setSynthetic(bool $boolean) Устанавливает, является ли это определение синтетическим, то есть не создаваемым контейнером, а динамически вводимым. | из Definition |
| bool | isSynthetic() Является ли это определение синтетическим, то есть не созданным контейнером, а динамически инжектированным. | from Definition |
| $this | setAbstract(bool $boolean) Является ли это определение абстрактным, то есть оно служит лишь шаблоном для других определений. | from Definition |
| bool | isAbstract() Является ли это определение абстрактным, то есть оно служит лишь шаблоном для других определений. | from Definition |
| $this | setConfigurator(callable $callable) Устанавливает конфигуратор, вызываемый после полного инициализации сервиса. | |
| callable|null | getConfigurator() Возвращает конфигуратор, вызываемый после полного инициализации сервиса. | from Definition |
| string | getParent() Возвращает декорацию Definition. | |
| array | getChanges() Возвращает все отслеженные изменения для объекта Definition. |
Подробности
__construct(string $parent)
Параметры
| string | $parent | Идентификатор экземпляра Definition, который нужно декорировать |
$this setFactory($callable)
Устанавливает фабрику.
Параметры
| $callable |
Значение результата
| $this |
string|array getFactory()
Получает фабрику.
Значение результата
| string|array | PHP функция или массив, содержащий класс/ссылку и метод для вызова |
$this setFactoryClass($class)
Устанавливает имя класса, который выступает в роли фабрики, используя фабричный метод, который будет вызываться статически.
Параметры
| $class |
Значение результата
| $this |
string|null getFactoryClass($triggerDeprecationError = true) устаревшее
устаревшее
Получает класс фабрики.
Параметры
| $triggerDeprecationError |
Значение результата
| string|null | Имя класса фабрики |
$this setFactoryMethod($method)
Устанавливает фабричный метод, способный создать экземпляр этого класса.
Параметры
| $method |
Значение результата
| $this |
$this setDecoratedService(null|string $id, null|string $renamedId = null)
Устанавливает сервис, который декорирует этот сервис.
Параметры
| null|string | $id | Идентификатор декорируемого сервиса, использовать null для удаления декорации |
| null|string | $renamedId | Новый идентификатор декорируемого сервиса |
Значение результата
| $this |
Исключения
| InvalidArgumentException | В случае, если идентификатор декорируемого сервиса и новый идентификатор декорируемого сервиса совпадают. |
null|array getDecoratedService()
Получает сервис, который декорирует этот сервис.
Значение результата
| null|array | Массив, состоящий из идентификатора декорируемого сервиса и нового идентификатора для него, null, если сервис не декорируется |
string|null getFactoryMethod($triggerDeprecationError = true) устаревшее
устаревшее
Получает фабричный метод.
Параметры
| $triggerDeprecationError |
Значение результата
| string|null | Имя фабричного метода |
$this setFactoryService($service, $triggerDeprecationError = true)
Устанавливает имя сервиса, который выступает в роли фабрики, используя фабричный метод.
Параметры
| $service | ||
| $triggerDeprecationError |
Значение результата
| $this |
string|null getFactoryService($triggerDeprecationError = true) устаревшее
устаревшее
Получает идентификатор сервиса-фабрики.
Параметры
| $triggerDeprecationError |
Значение результата
| string|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 $index, mixed $value)
Всегда используйте этот метод при перезаписи существующих аргументов родительского определения.
Если вы напрямую вызываете setArguments(), помните, что вам необходимо следовать определенным соглашениям, когда вы хотите перезаписать аргументы родительского определения, иначе ваши аргументы будут только добавлены.
Параметры
| int | $index | |
| mixed | $value |
Значение результата
| $this |
Исключения
| InvalidArgumentException | если $index не является целым числом |
array getArguments()
Получает аргументы для передачи конструктору/методу фабрики сервиса.
Значение результата
| array | Массив аргументов |
mixed getArgument(int $index)
Получает аргумент для передачи конструктору/методу фабрики сервиса.
Если был использован replaceArgument() для замены аргумента, этот метод вернёт значение замены.
Параметры
| int | $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()
Получает методы для вызова после инициализации сервиса.
Возвращаемое значение
| массив | Массив вызовов методов |
$this setTags(array $tags)
Устанавливает теги для этого определения.
Параметры
| массив | $tags |
Возвращаемое значение
| $this |
массив getTags()
Возвращает все теги.
Возвращаемое значение
| массив | Массив тегов |
массив getTag(string $name)
Возвращает тег по имени.
Параметры
| строка | $name | Имя тега |
Возвращаемое значение
| массив | Массив атрибутов |
$this addTag(string $name, array $attributes = array())
Добавляет тег для этого определения.
Параметры
| строка | $name | Имя тега |
| массив | $attributes | Массив атрибутов |
Возвращаемое значение
| $this |
bool hasTag(string $name)
Является ли данное определение тегом с указанным именем.
Параметры
| строка | $name |
Возвращаемое значение
| bool |
$this clearTag(string $name)
Очищает все теги для данного имени.
Параметры
| строка | $name | Имя тега |
Возвращаемое значение
| $this |
$this clearTags()
Очищает теги для данного определения.
Возвращаемое значение
| $this |
$this setFile(string $file)
Устанавливает файл, который требуется включить перед созданием сервиса.
Параметры
| строка | $file | Полный путь к файлу для включения |
Возвращаемое значение
| $this |
string|null getFile()
Получает файл, который требуется включить перед созданием сервиса.
Возвращаемое значение
| string|null | Полный путь к файлу для включения |
$this setScope(string $scope)
Устанавливает область действия сервиса.
Параметры
| строка | $scope | Требуется ли совместное использование сервиса |
Возвращаемое значение
| $this |
string getScope()
Возвращает область действия сервиса.
Возвращаемое значение
| строка |
$this setPublic(bool $boolean)
Устанавливает видимость этого сервиса.
Параметры
| bool | $boolean |
Возвращаемое значение
| $this |
bool isPublic()
Является ли этот сервис общедоступным.
Возвращаемое значение
| bool |
$this setSynchronized($boolean, $triggerDeprecationError = true) deprecated
deprecated
Устанавливает флаг синхронизации для этого сервиса.
Параметры
| $boolean | ||
| $triggerDeprecationError |
Возвращаемое значение
| $this |
bool isSynchronized($triggerDeprecationError = true) deprecated
deprecated
Является ли этот сервис синхронизированным.
Параметры
| $triggerDeprecationError |
Возвращаемое значение
| bool |
$this setLazy($boolean)
Устанавливает флаг лени для этого сервиса.
Параметры
| $boolean |
Возвращаемое значение
| $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 setConfigurator(callable $callable)
Устанавливает конфигуратор, который вызывается после полной инициализации сервиса.
Параметры
| callable | $callable | PHP вызываемая функция |
Возвращаемое значение
| $this |
callable|null getConfigurator()
Получает конфигуратор, который вызывается после полной инициализации сервиса.
Возвращаемое значение
| callable|null | PHP вызываемая функция для вызова |
string getParent()
Возвращает декорируемое определение.
Возвращаемое значение
| строка |
массив getChanges()
Возвращает все отслеживаемые изменения для объекта определения.
Возвращаемое значение
| массив | Массив изменений для этого определения |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/DependencyInjection/DefinitionDecorator.html
