Определение

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

Параметры

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

$this setFactory(string|array $factory)

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

Параметры

string|array

$factory

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

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

$this

string|array getFactory()

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

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

string|array

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

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

^{устарело}

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

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

Параметры

string

$factoryClass

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

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

$this

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

^{устарело}

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

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

Параметры

$triggerDeprecationError

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

string|null

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

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

^{устарело}

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

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

Параметры

string

$factoryMethod

Имя метода фабрики

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

$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) ^{устарело}

^{устарело}

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

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

Параметры

$triggerDeprecationError

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

string|null

Имя метода фабрики

$this setFactoryService($factoryService, $triggerDeprecationError = true) ^{устарело}

^{устарело}

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

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

Параметры

	$factoryService
	$triggerDeprecationError

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

$this

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

^{устарело}

since версия 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

$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 $index, mixed $argument)

Заменяет определённый аргумент.

Параметры

int	$index
mixed	$argument

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

$this

Исключения

OutOfBoundsException

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

array getArguments()

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

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

array

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

mixed getArgument(int $index)

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

Параметры

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

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

$this setShared(bool $shared)

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

Параметры

bool

$shared

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

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

$this

bool isShared()

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

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

bool

$this setScope($scope, $triggerDeprecationError = true) ^deprecated

^deprecated

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

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

Параметры

	$scope
	$triggerDeprecationError

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

$this

string getScope($triggerDeprecationError = true) ^deprecated

^deprecated

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

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

Параметры

$triggerDeprecationError

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

string

$this setPublic(bool $boolean)

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

Параметры

bool

$boolean

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

$this

bool isPublic()

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

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

bool

$this setSynchronized($boolean, $triggerDeprecationError = true) ^deprecated

^deprecated

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

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

Параметры

	$boolean
	$triggerDeprecationError

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

$this

bool isSynchronized($triggerDeprecationError = true) ^deprecated

^deprecated

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

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

Параметры

$triggerDeprecationError

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

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(callable $callable)

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

Параметры

callable

$callable

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

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

$this

callable|null getConfigurator()

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

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

callable|null

PHP вызываемый объект, который необходимо вызвать

$this setAutowiringTypes(array $types)

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

Параметры

array

$types

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

$this

bool isAutowired()

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

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

bool

$this setAutowired(bool $autowired)

Включает/отключает автозависимость.

Параметры

bool

$autowired

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

$this

string[] getAutowiringTypes()

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

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

string[]

$this addAutowiringType(string $type)

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

Параметры

string

$type

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

$this

$this removeAutowiringType(string $type)

Удаляет тип.

Параметры

string

$type

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

$this

bool hasAutowiringType(string $type)

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

Параметры

string

$type

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

bool