Spec-Zone.ru › Symfony 4.0

Определение

класс Определение

Определение представляет собой определение службы.

Методы

__construct(string|null $class = null, array $arguments = array())
массив getChanges()

Возвращает все отслеживаемые изменения для объекта Определения.

$this setChanges(array $changes)

Устанавливает отслеживаемые изменения для объекта Определения.

$this setFactory(string|array $factory)

Устанавливает фабрику.

строка|массив getFactory()

Получает фабрику.

$this setDecoratedService(null|string $id, null|string $renamedId = null, int $priority)

Устанавливает службу, которую эта служба декорирует.

null|массив getDecoratedService()

Получает службу, которую эта служба декорирует.

$this setClass(string $class)

Устанавливает класс службы.

строка|null getClass()

Получает класс службы.

$this setArguments(array $arguments)

Устанавливает аргументы, которые нужно передать конструктору или методу фабрики службы.

$this setProperties(array $properties)

Устанавливает свойства для определения при создании службы.

массив getProperties()

Получает свойства для определения при создании службы.

$this setProperty(string $name, mixed $value)

Устанавливает определённое свойство.

$this addArgument(mixed $argument)

Добавляет аргумент для передачи конструктору/методу фабрики службы.

$this replaceArgument(int|string $index, mixed $argument)

Заменяет определённый аргумент.

$this setArgument(int|string $key, mixed $value)

Устанавливает определённый аргумент.

массив getArguments()

Получает аргументы для передачи конструктору/методу фабрики службы.

mixed getArgument(int|string $index)

Получает аргумент для передачи конструктору/методу фабрики службы.

$this setMethodCalls(array $calls = array())

Устанавливает методы, которые нужно вызвать после инициализации службы.

$this addMethodCall(string $method, array $arguments = array())

Добавляет метод для вызова после инициализации службы.

$this removeMethodCall(string $method)

Удаляет метод для вызова после инициализации службы.

bool hasMethodCall(string $method)

Проверяет, содержит ли текущее определение метод для вызова после инициализации службы.

массив getMethodCalls()

Получает методы для вызова после инициализации службы.

$this setInstanceofConditionals(array $instanceof)

Устанавливает шаблоны определений, которые нужно применить условно к текущему определению, индексированные родительским интерфейсом/классом.

ChildDefinition[] getInstanceofConditionals()

Получает шаблоны определений, которые нужно применить условно к текущему определению, индексированные родительским интерфейсом/классом.

$this setAutoconfigured(bool $autoconfigured)

Устанавливает, должны ли условия instanceof предшествовать глобальному набору.

bool isAutoconfigured()
$this setTags(array $tags)

Устанавливает метки для этого определения.

массив getTags()

Возвращает все метки.

массив getTag(string $name)

Получает метку по имени.

$this addTag(string $name, array $attributes = array())

Добавляет метку для этого определения.

bool hasTag(string $name)

Является ли это определение имеет метку с данным именем.

$this clearTag(string $name)

Очищает все метки для данного имени.

$this clearTags()

Очищает метки для этого определения.

$this setFile(string $file)

Устанавливает файл, который нужно включить перед созданием службы.

строка|null getFile()

Получает файл, который нужно включить перед созданием службы.

$this setShared(bool $shared)

Устанавливает, должна ли служба быть общих или нет.

bool isShared()

Является ли эта служба общей.

$this setPublic(bool $boolean)

Устанавливает видимость этой службы.

bool isPublic()

Является ли эта служба общедоступной.

$this setPrivate(bool $boolean)

Устанавливает, является ли эта служба приватной.

bool isPrivate()

Является ли эта служба приватной.

$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()

Является ли это определение устаревшим, то есть его больше нельзя вызывать.

строка getDeprecationMessage(string $id)

Сообщение для использования, если это определение устарело.

$this setConfigurator(string|array $configurator)

Устанавливает конфигуратор для вызова после полной инициализации службы.

callable|null getConfigurator()

Получает конфигуратор для вызова после полной инициализации службы.

bool isAutowired()

Является ли определение автозависимым?

$this setAutowired(bool $autowired)

Включает/выключает автозависимость.

массив getBindings()

Получает привязки.

$this setBindings(array $bindings)

Устанавливает привязки.

addError(string $error)

Добавить ошибку, которая произошла при построении этого определения.

массив getErrors()

Возвращает любые ошибки, которые произошли при построении этого определения.

Подробности

__construct(string|null $class = null, array $arguments = array())

Параметры

string|null $class Класс сервиса
array $arguments Массив аргументов для передачи конструктору сервиса

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 ID декорируемого сервиса, используйте null для удаления декорации
null|string $renamedId Новый ID декорируемого сервиса
int $priority Приоритет декорации

Возвращаемое значение

$this

Исключения

InvalidArgumentException в случае, если ID декорируемого сервиса и новый ID декорируемого сервиса совпадают

null|array getDecoratedService()

Получает сервис, который декорируется этим сервисом.

Возвращаемое значение

null|array Массив, содержащий ID декорируемого сервиса, новый ID и приоритет декорации, 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 $argument)

Заменяет конкретный аргумент.

Параметры

int|string $index
mixed $argument

Возвращаемое значение

$this

Исключения

OutOfBoundsException Когда заменяемый аргумент не существует

$this setArgument(int|string $key, mixed $value)

Устанавливает определенный аргумент.

Параметры

int|string $key
mixed $value

Возвращаемое значение

$this

array getArguments()

Получает аргументы для передачи конструктору/методу фабрики сервиса.

Возвращаемое значение

array Массив аргументов

mixed getArgument(int|string $index)

Получает аргумент для передачи конструктору/методу фабрики сервиса.

Параметры

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)

Устанавливает, следует ли префиксным условным instanceof условиям глобальный набор.

Параметры

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)

Устанавливает, является ли этот сервис приватным.

При установке, состояние "приватный" имеет больший приоритет, чем "публичный". В версии 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 вызываемый объект

bool isAutowired()

Является ли определение автозависимым?

Возвращаемое значение

bool

$this setAutowired(bool $autowired)

Включает/выключает автозависимость.

Параметры

bool $autowired

Возвращаемое значение

$this

array getBindings()

Получает привязки.

Возвращаемое значение

array

$this setBindings(array $bindings)

Устанавливает привязки.

Привязки сопоставляют аргументы $named или FQCN с значениями, которые должны быть введены в соответствующие параметры (конструктора, вызываемых методов и действий контроллера).

Параметры

array $bindings

Возвращаемое значение

$this

addError(string $error)

Добавляет ошибку, возникшую при построении этого определения.

Параметры

string $error

array getErrors()

Возвращает любые ошибки, возникшие при построении этого определения.

Возвращаемое значение

array

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/DependencyInjection/Definition.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API