Spec-Zone.ru › Symfony 2.7

Определение

класс Определение

Определение представляет собой определение сервиса.

Методы

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

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

string|array getFactory()

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

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

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

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

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

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

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

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

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

null|array getDecoratedService()

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

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

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

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

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

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

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

$this setClass(string $class)

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

string|null getClass()

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

$this setArguments(array $arguments)

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

$this setProperties(array $properties)

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

array getProperties()

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

$this setProperty(string $name, mixed $value)

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

$this addArgument(mixed $argument)

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

$this replaceArgument(int $index, mixed $argument)

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

array getArguments()

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

mixed getArgument(int $index)

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

$this setMethodCalls(array $calls = array())

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

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

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

$this removeMethodCall(string $method)

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

bool hasMethodCall(string $method)

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

array getMethodCalls()

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

$this setTags(array $tags)

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

array getTags()

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

array getTag(string $name)

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

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

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

bool hasTag(string $name)

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

$this clearTag(string $name)

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

$this clearTags()

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

$this setFile(string $file)

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

string|null getFile()

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

$this setScope(string $scope)

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

string getScope()

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

$this setPublic(bool $boolean)

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

bool isPublic()

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

$this setSynchronized($boolean, $triggerDeprecationError = true) устарело

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

bool isSynchronized($triggerDeprecationError = true) устарело

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

$this setLazy(bool $lazy)

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

bool isLazy()

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

$this setSynthetic(bool $boolean)

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

bool isSynthetic()

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

$this setAbstract(bool $boolean)

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

bool isAbstract()

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

$this setConfigurator(callable $callable)

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

callable|null getConfigurator()

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

Подробное описание

__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) устарело

устарело

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

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

Параметры

string $factoryClass Имя класса фабрики

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

$this

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

устарело

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

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

Параметры

$triggerDeprecationError

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

string|null Имя класса фабрики

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

устарело

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

Исключения

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

null|array getDecoratedService()

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

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

null|array Массив, состоящий из идентификатора декорируемого сервиса и нового идентификатора для него, null, если сервис не декорирован

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

устарело

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

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

Параметры

$triggerDeprecationError

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

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

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

устарело

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

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

Параметры

$factoryService
$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

$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 setScope(string $scope)

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

Параметры

string $scope Требуется ли совместное использование сервиса

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

$this

string getScope()

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

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

string

$this setPublic(bool $boolean)

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

Параметры

bool $boolean

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

$this

bool isPublic()

Является ли данный сервис публичным.

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

bool

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

deprecated

since version 2.7, will be removed in 3.0.

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

Параметры

$boolean
$triggerDeprecationError

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

$this

bool isSynchronized($triggerDeprecationError = true) deprecated

deprecated

since version 2.7, will be removed in 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 setConfigurator(callable $callable)

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

Параметры

callable $callable PHP callable

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

$this

callable|null getConfigurator()

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

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

callable|null PHP callable для вызова

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/DependencyInjection/Definition.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API