Определение

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

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

Значение результата

string|array|null

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

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

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

Параметры

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

Значение результата

$this

Исключения

InvalidArgumentException

в случае, если идентификатор декорированного сервиса и новый идентификатор декорированного сервиса равны

array|null getDecoratedService()

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

Значение результата

array|null

Массив, состоящий из идентификатора декорированного сервиса, нового идентификатора и приоритета декорации, 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)

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

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

bool isAutowired()

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

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

bool

$this setAutowired(bool $autowired)

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

Параметры

bool

$autowired

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

$this

array|BoundArgument[] getBindings()

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

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

array|BoundArgument[]

$this setBindings(array $bindings)

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

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

Параметры

array

$bindings

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

$this

$this addError(string $error)

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

Параметры

string

$error

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

$this

array getErrors()

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

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

array