Определение

__construct(string|null $class = null, array $arguments = array())

Параметры

string|null	$class	Класс сервиса
array	$arguments	Массив аргументов для передачи конструктору сервиса

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

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

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

string|array

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

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

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

Параметры

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

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

$this

Исключения

InvalidArgumentException

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

null|array getDecoratedService()

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

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

null|array

Массив, содержащий ID декорируемого сервиса, новый ID и приоритет декорации, 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 $argument)

Заменяет конкретный аргумент.

Параметры

int|string	$index
mixed	$argument

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

$this

Исключения

OutOfBoundsException

Когда заменяемый аргумент не существует

$this setArgument(int|string $key, mixed $value)

Устанавливает определенный аргумент.

Параметры

int|string	$key
mixed	$value

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

$this

array getArguments()

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

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

array

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

mixed getArgument(int|string $index)

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

Параметры

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)

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

Параметры

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)

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

При установке, состояние "приватный" имеет больший приоритет, чем "публичный". В версии 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

$this setAutowiringTypes(array $types) ^{устарело}

^{устарело}

с версии 3.3, будет удалено в 4.0.

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

Параметры

array

$types

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

$this

bool isAutowired()

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

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

bool

$this setAutowired(bool $autowired)

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

Параметры

bool

$autowired

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

$this

string[] getAutowiringTypes() ^{устарело}

^{устарело}

с версии 3.3, будет удалено в 4.0.

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

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

string[]

$this addAutowiringType(string $type) ^{устарело}

^{устарело}

с версии 3.3, будет удалено в 4.0.

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

Параметры

string

$type

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

$this

$this removeAutowiringType(string $type) ^deprecated

^deprecated

since версия 3.3, будет удалена в 4.0.

Удаляет тип.

Параметры

string

$type

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

$this

bool hasAutowiringType(string $type) ^deprecated

^deprecated

since версия 3.3, будет удалена в 4.0.

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

Параметры

string

$type

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

bool

array getBindings()

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

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

array

$this setBindings(array $bindings)

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

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

Параметры

array

$bindings

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

$this

addError(string $error)

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

Параметры

string

$error

array getErrors()

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

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

array