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