DefinitionDecorator

__construct(string $parent)

Параметры

string

$parent

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

$this setFactory($callable)

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

Параметры

$callable

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

$this

string|array getFactory()

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

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

string|array

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

$this setFactoryClass($class)

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

Параметры

$class

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

$this

string|null getFactoryClass($triggerDeprecationError = true) ^{устарело}

^{устарело}

с версией 2.6, будет удалено в 3.0.

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

Параметры

$triggerDeprecationError

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

string|null

Имя класса фабрики

$this setFactoryMethod($method)

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

Параметры

$method

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

$this

$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, если сервис не декорируется

string|null getFactoryMethod($triggerDeprecationError = true) ^{устарело}

^{устарело}

с версией 2.6, будет удалено в 3.0.

Получает фабричный метод.

Параметры

$triggerDeprecationError

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

string|null

Имя фабричного метода

$this setFactoryService($service, $triggerDeprecationError = true)

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

Параметры

	$service
	$triggerDeprecationError

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

$this

string|null getFactoryService($triggerDeprecationError = true) ^{устарело}

^{устарело}

с версией 2.6, будет удалено в 3.0.

Получает идентификатор сервиса-фабрики.

Параметры

$triggerDeprecationError

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

string|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

массив getMethodCalls()

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

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

массив

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

$this setTags(массив $tags)

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

Параметры

массив

$tags

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

$this

массив getTags()

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

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

массив

Массив тегов

массив getTag(строка $name)

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

Параметры

строка

$name

Имя тега

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

массив

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

$this addTag(строка $name, массив $attributes = массив())

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

Параметры

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

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

$this

логическое hasTag(строка $name)

Определяет, содержит ли это определение тег с заданным именем.

Параметры

строка

$name

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

логическое

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

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

Параметры

строка

$name

Имя тега

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

$this

$this clearTags()

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

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

$this

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

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

Параметры

строка

$file

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

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

$this

строка|null getFile()

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

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

строка|null

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

Определение setShared(логическое $shared)

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

Параметры

логическое

$shared

Необходимо ли использовать общий сервис

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

Определение

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

логическое isShared()

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

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

логическое

$this setScope($scope, $triggerDeprecationError = true) ^{устаревший}

^{устаревший}

с момента версии 2.8, будет удален в 3.0.

Устанавливает область действия сервиса.

Параметры

	$scope
	$triggerDeprecationError

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

$this

строка getScope($triggerDeprecationError = true) ^{устаревший}

^{устаревший}

с момента версии 2.8, будет удален в 3.0.

Возвращает область действия сервиса.

Параметры

$triggerDeprecationError

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

строка

$this setPublic(логическое $boolean)

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

Параметры

логическое

$boolean

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

$this

логическое isPublic()

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

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

логическое

$this setSynchronized($boolean, $triggerDeprecationError = true) ^{устаревший}

^{устаревший}

с момента версии 2.7, будет удален в 3.0.

Устанавливает флаг синхронизации этого сервиса.

Параметры

	$boolean
	$triggerDeprecationError

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

$this

логическое isSynchronized($triggerDeprecationError = true) ^{устаревший}

^{устаревший}

с момента версии 2.7, будет удален в 3.0.

Является ли этот сервис синхронизированным.

Параметры

$triggerDeprecationError

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

логическое

$this setLazy($boolean)

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

Параметры

$boolean

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

$this

логическое isLazy()

Является ли этот сервис ленивым.

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

логическое

$this setSynthetic(логическое $boolean)

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

Параметры

логическое

$boolean

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

$this

логическое isSynthetic()

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

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

логическое

$this setAbstract(логическое $boolean)

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

Параметры

логическое

$boolean

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

$this

логическое isAbstract()

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

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

логическое

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

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

Параметры

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

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

Определение

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

Исключения

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

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

логическое isDeprecated()

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

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

логическое

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

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

Параметры

строка

$id

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

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

строка

$this setConfigurator(вызываемый объект $callable)

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

Параметры

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

$callable

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

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

$this

вызываемый объект|null getConfigurator()

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

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

callable|null

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

Definition setAutowiringTypes(array $types)

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

Параметры

массив

$types

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

Definition

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

bool isAutowired()

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

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

bool

Definition setAutowired(bool $autowired)

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

Параметры

bool

$autowired

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

Definition

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

string[] getAutowiringTypes()

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

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

string[]

Definition addAutowiringType(string $type)

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

Параметры

строка

$type

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

Definition

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

Definition removeAutowiringType(string $type)

Удаляет тип.

Параметры

строка

$type

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

Definition

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

bool hasAutowiringType(string $type)

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

Параметры

строка

$type

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

bool

string getParent()

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

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

строка

array getChanges()

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

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

массив

Массив изменений для данного Definition