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)

Вždy используйте этот метод при перезаписи существующих аргументов родительского определения.

Если вы напрямую вызываете 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

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

Definition setShared(bool $shared)

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

Параметры

bool

$shared

Требуется ли общий сервис

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

Definition

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

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

Definition setDeprecated($boolean = true, string $template = null)

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

Параметры

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

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

Definition

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

Исключения

InvalidArgumentException

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

bool isDeprecated()

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

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

bool

string getDeprecationMessage(string $id)

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

Параметры

string

$id

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

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

string

$this setConfigurator($callable)

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

Параметры

$callable

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

$this

callable|null getConfigurator()

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

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

callable|null

Вызываемый PHP callable

Definition setAutowiringTypes(array $types)

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

Параметры

array

$types

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

Definition

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

bool isAutowired()

Используется ли автоматическое подключение для определения?

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

bool

Definition setAutowired(bool $autowired)

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

Параметры

bool

$autowired

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

Definition

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

string[] getAutowiringTypes()

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

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

string[]

Definition addAutowiringType(string $type)

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

Параметры

string

$type

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

Definition

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

Definition removeAutowiringType(string $type)

Удаляет тип.

Параметры

string

$type

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

Definition

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

bool hasAutowiringType(string $type)

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

Параметры

string

$type

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

bool

string getParent()

Возвращает Definition, который декорируется.

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

string

array getChanges()

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

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

array

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