ChildDefinition

__construct(string $parent)

Параметры

string

$parent

Идентификатор экземпляра Definition, который нужно декорировать

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|null getFactory()

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

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

string|array|null

PHP-функция или массив, содержащий класс/ссылку и метод для вызова

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

Устанавливает сервис, который декорирует данный сервис.

Параметры

string|null	$id	Идентификатор декорируемого сервиса, use null для удаления декорирования
string|null	$renamedId	Новый идентификатор декорируемого сервиса
int	$priority	Приоритет декорирования

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

$this

Исключения

InvalidArgumentException

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

array|null getDecoratedService()

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

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

array|null

Массив, составленный из идентификатора декорируемого сервиса, нового идентификатора для него и приоритета декорирования, 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 $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

Массив вызовов методов

$this setInstanceofConditionals(array $instanceof)

Параметры

array

$instanceof

ChildDefinition[]

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

$this

ChildDefinition[] getInstanceofConditionals()

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

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

ChildDefinition[]

$this setAutoconfigured(bool $autoconfigured)

Параметры

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)

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

При установке состояние "private" имеет больший приоритет, чем "public". В версии 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|BoundArgument[] getBindings()

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

Значение возвращаемого значения

array|BoundArgument[]

$this setBindings(array $bindings)

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

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

Параметры

array

$bindings

Значение возвращаемого значения

$this

$this addError(string $error)

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

Параметры

string

$error

Значение возвращаемого значения

$this

array getErrors()

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

Значение возвращаемого значения

array

string getParent()

Возвращает определение, от которого нужно унаследовать.

Значение возврата

string

$this setParent(string $parent)

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

Параметры

string

$parent

Значение возврата

$this