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