FormConfigInterface
интерфейс FormConfigInterface
Конфигурация объекта {@link Form}.
Методы
| EventDispatcherInterface | getEventDispatcher() Возвращает диспетчер событий, используемый для отправки событий формы. | |
| string | getName() Возвращает имя формы, используемое в качестве HTTP параметра. | |
| null|PropertyPathInterface | getPropertyPath() Возвращает путь к свойству, к которому должна быть сопоставлена форма. | |
| bool | getMapped() Возвращает, должна ли форма быть сопоставлена элементу данных родительского объекта. | |
| bool | getByReference() Возвращает, должно ли изменение данных формы происходить по ссылке. | |
| bool | getInheritData() Возвращает, должна ли форма считывать и записывать данные родительского объекта. | |
| bool | getCompound() Возвращает, является ли форма составной. | |
| ResolvedFormTypeInterface | getType() Возвращает тип формы, используемый для построения формы. | |
| DataTransformerInterface[] | getViewTransformers() Возвращает преобразователи представления формы. | |
| DataTransformerInterface[] | getModelTransformers() Возвращает преобразователи модели формы. | |
| DataMapperInterface | getDataMapper() Возвращает маппер данных формы. | |
| bool | getRequired() Возвращает, является ли форма обязательной. | |
| bool | getDisabled() Возвращает, является ли форма отключенной. | |
| bool | getErrorBubbling() Возвращает, будут ли ошибки, присоединенные к форме, передаваться родительскому объекту. | |
| mixed | getEmptyData() Возвращает данные, которые должны быть возвращены, когда форма пуста. | |
| array | getAttributes() Возвращает дополнительные атрибуты формы. | |
| bool | hasAttribute(string $name) Возвращает, существует ли атрибут с заданным именем. | |
| mixed | getAttribute(string $name, mixed $default = null) Возвращает значение заданного атрибута. | |
| mixed | getData() Возвращает начальные данные формы. | |
| string | getDataClass() Возвращает класс данных формы или null, если данные являются скалярными или массивом. | |
| bool | getDataLocked() Возвращает, заблокированы ли данные формы. | |
| FormFactoryInterface | getFormFactory() Возвращает фабрику форм, используемую для создания новых форм. | |
| string | getAction() Возвращает целевой URL формы. | |
| string | getMethod() Возвращает HTTP-метод, используемый формой. | |
| RequestHandlerInterface | getRequestHandler() Возвращает обработчик запросов, используемый формой. | |
| bool | getAutoInitialize() Возвращает, должна ли форма инициализироваться при создании. | |
| array | getOptions() Возвращает все опции, переданные при построении формы. | |
| bool | hasOption(string $name) Возвращает, существует ли определенная опция. | |
| mixed | getOption(string $name, mixed $default = null) Возвращает значение определенной опции. |
Подробное описание
EventDispatcherInterface getEventDispatcher()
Возвращает диспетчер событий, используемый для отправки событий формы.
Значение возврата
| EventDispatcherInterface | Диспетчер |
string getName()
Возвращает имя формы, используемое в качестве параметра HTTP.
Значение возврата
| string | Имя формы |
null|PropertyPathInterface getPropertyPath()
Возвращает путь к свойству, к которому должна быть сопоставлена форма.
Значение возврата
| null|PropertyPathInterface | Путь к свойству |
bool getMapped()
Возвращает значение, указывающее, должна ли форма быть сопоставлена с элементом данных родительского объекта.
Значение возврата
| bool | Сопоставлена ли форма |
bool getByReference()
Возвращает значение, указывающее, должны ли данные формы изменяться по ссылке.
Значение возврата
| bool | Изменять данные формы по ссылке |
bool getInheritData()
Возвращает значение, указывающее, должна ли форма читать и записывать данные своего родителя.
Значение возврата
| bool | Форма должна наследовать данные родителя |
bool getCompound()
Возвращает значение, указывающее, является ли форма составной.
Это свойство независимо от того, имеет ли форма дочерние элементы. Форма может быть составной и не иметь дочерних элементов, например, пустая коллекционная форма.
Значение возврата
| bool | Форма составная |
ResolvedFormTypeInterface getType()
Возвращает типы форм, используемые для построения формы.
Значение возврата
| ResolvedFormTypeInterface | Тип формы |
DataTransformerInterface[] getViewTransformers()
Возвращает преобразователи представления формы.
Значение возврата
| DataTransformerInterface[] | Массив экземпляров {@link DataTransformerInterface} |
DataTransformerInterface[] getModelTransformers()
Возвращает преобразователи модели формы.
Значение возврата
| DataTransformerInterface[] | Массив экземпляров {@link DataTransformerInterface} |
DataMapperInterface getDataMapper()
Возвращает маппер данных формы.
Значение возврата
| DataMapperInterface | Маппер данных |
bool getRequired()
Возвращает значение, указывающее, является ли форма обязательной.
Значение возврата
| bool | Обязательная форма |
bool getDisabled()
Возвращает значение, указывающее, заблокирована ли форма.
Значение возврата
| bool | Заблокирована ли форма |
bool getErrorBubbling()
Возвращает значение, указывающее, будут ли ошибки, прикрепленные к форме, передаваться родителю.
Значение возврата
| bool | Будут ли ошибки переданы вверх |
mixed getEmptyData()
Возвращает данные, которые должны возвращаться, когда форма пустая.
Значение возврата
| mixed | Данные, возвращаемые при пустой форме |
array getAttributes()
Возвращает дополнительные атрибуты формы.
Значение возврата
| array | Массив пар ключ-значение |
bool hasAttribute(string $name)
Возвращает значение, указывающее, существует ли атрибут с данным именем.
Параметры
| string | $name | Имя атрибута |
Значение возврата
| bool | Существует ли атрибут |
mixed getAttribute(string $name, mixed $default = null)
Возвращает значение данного атрибута.
Параметры
| string | $name | Имя атрибута |
| mixed | $default | Значение, возвращаемое, если атрибут не существует |
Значение возврата
| mixed | Значение атрибута |
mixed getData()
Возвращает исходные данные формы.
Значение возврата
| mixed | Исходные данные формы |
string getDataClass()
Возвращает класс данных формы или null, если данные являются скалярами или массивом.
Значение возврата
| string | Класс данных или null |
bool getDataLocked()
Возвращает значение, указывающее, заблокированы ли данные формы.
Форма с заблокированными данными ограничена данными, переданными в этой конфигурации. Тогда данные можно изменить только путем отправки формы.
Значение возврата
| bool | Заблокированы ли данные |
FormFactoryInterface getFormFactory()
Возвращает фабрику форм, используемую для создания новых форм.
Значение возврата
| FormFactoryInterface | Фабрика форм |
string getAction()
Возвращает целевой URL формы.
Значение возврата
| string | Целевой URL формы |
string getMethod()
Возвращает HTTP-метод, используемый формой.
Значение возврата
| string | HTTP-метод формы |
RequestHandlerInterface getRequestHandler()
Возвращает обработчик запроса, используемый формой.
Значение возврата
| RequestHandlerInterface | Обработчик запроса |
bool getAutoInitialize()
Возвращает значение, указывающее, должна ли форма инициализироваться при создании.
Значение возврата
| bool | Возвращает true, если форма должна быть инициализирована при создании, иначе false. |
array getOptions()
Возвращает все параметры, переданные во время создания формы.
Значение возврата
| array | Переданные параметры |
bool hasOption(string $name)
Возвращает значение, указывающее, существует ли определенный параметр.
Параметры
| string | $name | Имя параметра, |
Значение возврата
| bool | Существует ли параметр |
mixed getOption(string $name, mixed $default = null)
Возвращает значение определенного параметра.
Параметры
| string | $name | Имя параметра |
| mixed | $default | Значение, возвращаемое, если параметр не существует |
Значение возврата
| mixed | Значение параметра |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/Form/FormConfigInterface.html