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() Возвращает начальные данные формы. | |
| null|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 | Исходные данные формы |
null|string getDataClass()
Возвращает класс данных формы или null, если данные являются скаляром или массивом.
Значение возврата
| 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.3/Symfony/Component/Form/FormConfigInterface.html