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.0/Symfony/Component/Form/FormConfigInterface.html