DefinitionDecorator

__construct(string $parent)

Параметры

string

$parent

Идентификатор экземпляра Definition для декорирования

$this setFactory($callable)

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

Параметры

$callable

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

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

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

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

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

Полный путь к файлу для включения

Определение setShared(bool $shared)

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

Параметры

bool

$shared

Нужно ли, чтобы сервис был общим

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

Определение

Текущий экземпляр

bool isShared()

Является ли этот сервис общим.

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

bool

$this setPublic(bool $boolean)

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

Параметры

bool

$boolean

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

$this

bool isPublic()

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

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

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

Определение setDeprecated($boolean = true, string $template = null)

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

Параметры

	$boolean
string	$template	Сообщение шаблона, используемое, если определение устарело

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

Определение

текущий экземпляр

Исключения

Исключение неверного аргумента

При некорректном шаблоне сообщения.

bool isDeprecated()

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

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

bool

string getDeprecationMessage(string $id)

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

Параметры

string

$id

Идентификатор сервиса, использующего это определение

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

string

$this setConfigurator(callable $callable)

Устанавливает конфигуратор, вызываемый после полного инициализации сервиса.

Параметры

callable

$callable

PHP-вызов

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

$this

callable|null getConfigurator()

Получает конфигуратор, вызываемый после полного инициализации сервиса.

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

callable|null

PHP-вызов для вызова

Определение setAutowiringTypes(array $types)

Устанавливает типы, которые будут по умолчанию относиться к этому определению.

Параметры

array

$types

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

Определение

Текущий экземпляр

bool isAutowired()

Автоматически ли внедряется определение?

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

bool

Определение setAutowired(bool $autowired)

Устанавливает автоматическое внедрение.

Параметры

bool

$autowired

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

Определение

Текущий экземпляр

string[] getAutowiringTypes()

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

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

string[]

Определение addAutowiringType(string $type)

Добавляет тип, который будет по умолчанию относиться к этому определению.

Параметры

string

$type

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

Определение

Текущий экземпляр

Определение removeAutowiringType(string $type)

Удаляет тип.

Параметры

string

$type

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

Определение

Текущий экземпляр

bool hasAutowiringType(string $type)

Будет ли это определение по умолчанию для данного типа?

Параметры

string

$type

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

bool

string getParent()

Возвращает определяемое определение.

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

string

array getChanges()

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

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

array

Массив изменений для этого определения