DefinitionDecorator

__construct(string $parent)

Конструктор.

Параметры

string

$parent

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

Definition setFactory($callable)

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

Параметры

$callable

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

Definition

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

string|array getFactory()

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

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

string|array

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

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

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

Параметры

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

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

Definition

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

Исключения

InvalidArgumentException

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

null|array getDecoratedService()

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

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

null|array

Массив, содержащий идентификатор декорируемого сервиса, новый идентификатор и приоритет декорации, null, если сервис не декорируется

Definition setClass(string $class)

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

Параметры

string

$class

Класс сервиса

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

Definition

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

string|null getClass()

Получает класс сервиса.

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

string|null

Класс сервиса

Definition setArguments(array $arguments)

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

Параметры

array

$arguments

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

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

Definition

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

setProperties(array $properties)

Параметры

array

$properties

getProperties()

setProperty($name, $value)

Параметры

	$name
	$value

Definition addArgument(mixed $argument)

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

Параметры

mixed

$argument

Аргумент

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

Definition

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

Definition replaceArgument(int $index, mixed $value)

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

Если вы напрямую вызываете setArguments(), помните, что вам необходимо соблюдать определенные соглашения, когда вы хотите перезаписать аргументы родительского определения, в противном случае ваши аргументы будут только добавлены.

Параметры

int	$index
mixed	$value

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

Definition

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

Исключения

InvalidArgumentException

если $index не является целым числом

array getArguments()

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

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

array

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

mixed getArgument(int $index)

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

Если replaceArgument() был использован для замены аргумента, этот метод вернёт значение замены.

Параметры

int

$index

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

mixed

Значение аргумента

Исключения

OutOfBoundsException

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

Definition setMethodCalls(array $calls = array())

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

Параметры

array

$calls

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

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

Definition

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

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

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

Параметры

string	$method	Имя метода для вызова
array	$arguments	Массив аргументов для передачи в вызов метода

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

Definition

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

Исключения

InvalidArgumentException

при пустом параметре $method

Definition removeMethodCall(string $method)

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

Параметры

string

$method

Имя метода для удаления

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

Definition

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

bool hasMethodCall(string $method)

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

Параметры

string

$method

Имя метода для поиска

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

bool

array getMethodCalls()

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

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

array

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

Definition setTags(array $tags)

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

Параметры

array

$tags

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

Definition

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

array getTags()

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

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

array

Массив тегов

array getTag(string $name)

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

Параметры

string

$name

Имя тега

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

array

Массив атрибутов

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

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

Параметры

строка	$name	Имя тега
массив	$attributes	Массив атрибутов

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

Definition

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

bool hasTag(строка $name)

Возвращает значение true, если для определения есть тег с заданным именем.

Параметры

строка

$name

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

bool

Definition clearTag(строка $name)

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

Параметры

строка

$name

Имя тега

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

Definition

Definition clearTags()

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

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

Definition

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

Definition setFile(строка $file)

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

Параметры

строка

$file

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

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

Definition

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

строка|null getFile()

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

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

строка|null

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

Definition setShared(bool $shared)

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

Параметры

bool

$shared

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

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

Definition

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

bool isShared()

Возвращает true, если сервис общий.

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

bool

Definition setPublic(bool $boolean)

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

Параметры

bool

$boolean

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

Definition

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

bool isPublic()

Возвращает true, если сервис общедоступен.

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

bool

Definition setLazy($boolean)

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

Параметры

$boolean

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

Definition

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

bool isLazy()

Возвращает true, если сервис лениво загружается.

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

bool

Definition setSynthetic(bool $boolean)

Устанавливает, является ли это определение синтетическим (не создается контейнером, а динамически инжектируется).

Параметры

bool

$boolean

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

Definition

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

bool isSynthetic()

Возвращает true, если это определение синтетическое.

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

bool

Definition setAbstract(bool $boolean)

Устанавливает, является ли это определение абстрактным (служит шаблоном для других определений).

Параметры

bool

$boolean

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

Definition

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

bool isAbstract()

Возвращает true, если это определение абстрактное.

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

bool

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

Устанавливает, является ли это определение устаревшим (больше не должно вызываться).

Параметры

	$boolean
строка	$template	Сообщение о устаревании

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

Definition

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

Исключения

InvalidArgumentException

При неверном шаблоне сообщения

bool isDeprecated()

Возвращает true, если это определение устаревшее.

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

bool

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

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

Параметры

строка

$id

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

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

строка

Definition setConfigurator(вызываемый $callable)

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

Параметры

вызываемый

$callable

PHP вызываемый объект

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

Definition

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

вызываемый|null getConfigurator()

Возвращает конфигуратор, который будет вызван после полной инициализации сервиса.

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

вызываемый|null

PHP вызываемый объект

Definition setAutowiringTypes(массив $types)

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

Параметры

массив

$types

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

Definition

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

bool isAutowired()

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

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

bool

Definition setAutowired($autowired)

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

Параметры

$autowired

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

Definition

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

строка[] getAutowiringTypes()

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

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

строка[]

Definition addAutowiringType(строка $type)

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

Параметры

строка

$type

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

Definition

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

Definition removeAutowiringType(строка $type)

Удаляет тип.

Параметры

строка

$type

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

Definition

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

bool hasAutowiringType(string $type)

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

Параметры

string

$type

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

bool

string getParent()

Возвращает декорируемую запись.

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

string

array getChanges()

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

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

array

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