Spec-Zone.ru › Symfony 3.0

FormConfigBuilderInterface

интерфейс FormConfigBuilderInterface реализует FormConfigInterface

Методы

EventDispatcherInterface getEventDispatcher()

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

из FormConfigInterface
string getName()

Возвращает имя формы, используемой в качестве HTTP-параметра.

из FormConfigInterface
null|PropertyPathInterface getPropertyPath()

Возвращает путь к свойству, к которому должна быть отображена форма.

из FormConfigInterface
bool getMapped()

Возвращает, должна ли форма быть отображена на элемент данных родительского элемента.

из FormConfigInterface
bool getByReference()

Возвращает, должно ли данные формы изменяться по ссылке.

из FormConfigInterface
bool getInheritData()

Возвращает, должна ли форма читать и записывать данные родительского элемента.

из FormConfigInterface
bool getCompound()

Возвращает, является ли форма составной.

из FormConfigInterface
ResolvedFormTypeInterface getType()

Возвращает типы форм, используемые для построения формы.

из FormConfigInterface
DataTransformerInterface[] getViewTransformers()

Возвращает преобразователи представления формы.

из FormConfigInterface
DataTransformerInterface[] getModelTransformers()

Возвращает преобразователи модели формы.

из FormConfigInterface
DataMapperInterface getDataMapper()

Возвращает мапер данных формы.

из FormConfigInterface
bool getRequired()

Возвращает, является ли форма обязательной.

из FormConfigInterface
bool getDisabled()

Возвращает, является ли форма отключённой.

из FormConfigInterface
bool getErrorBubbling()

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

из FormConfigInterface
mixed getEmptyData()

Возвращает данные, которые должны быть возвращены, когда форма пуста.

из FormConfigInterface
array getAttributes()

Возвращает дополнительные атрибуты формы.

из FormConfigInterface
bool hasAttribute(string $name)

Возвращает, существует ли атрибут с заданным именем.

из FormConfigInterface
mixed getAttribute(string $name, mixed $default = null)

Возвращает значение заданного атрибута.

из FormConfigInterface
mixed getData()

Возвращает начальные данные формы.

из FormConfigInterface
string getDataClass()

Возвращает класс данных формы или null, если данные являются скаляром или массивом.

из FormConfigInterface
bool getDataLocked()

Возвращает, заблокированы ли данные формы.

из FormConfigInterface
FormFactoryInterface getFormFactory()

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

из FormConfigInterface
string getAction()

Возвращает целевой URL формы.

из FormConfigInterface
string getMethod()

Возвращает HTTP-метод, используемый формой.

из FormConfigInterface
RequestHandlerInterface getRequestHandler()

Возвращает обработчик запроса, используемый формой.

из FormConfigInterface
bool getAutoInitialize()

Возвращает, должна ли форма инициализироваться при создании.

из FormConfigInterface
array getOptions()

Возвращает все опции, переданные при построении формы.

из FormConfigInterface
bool hasOption(string $name)

Возвращает, существует ли определенная опция.

из FormConfigInterface
mixed getOption(string $name, mixed $default = null)

Возвращает значение определенной опции.

из FormConfigInterface
FormConfigBuilderInterface addEventListener(string $eventName, callable $listener, int $priority)

Добавляет обработчик событий для события этой формы.

FormConfigBuilderInterface addEventSubscriber(EventSubscriberInterface $subscriber)

Добавляет подписчика на события для событий этой формы.

FormConfigBuilderInterface addViewTransformer(DataTransformerInterface $viewTransformer, bool $forcePrepend = false)

Добавляет/вставляет преобразователь в цепочку преобразователей представления.

FormConfigBuilderInterface resetViewTransformers()

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

FormConfigBuilderInterface addModelTransformer(DataTransformerInterface $modelTransformer, bool $forceAppend = false)

Вставляет/добавляет преобразователь в цепочку преобразователей нормализации.

FormConfigBuilderInterface resetModelTransformers()

Очищает нормализующие преобразователи.

FormConfigBuilderInterface setAttribute(string $name, mixed $value)

Устанавливает значение для атрибута.

FormConfigBuilderInterface setAttributes(array $attributes)

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

FormConfigBuilderInterface setDataMapper(DataMapperInterface $dataMapper = null)

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

FormConfigBuilderInterface setDisabled(bool $disabled)

Устанавливает, отключена ли форма.

FormConfigBuilderInterface setEmptyData(mixed $emptyData)

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

FormConfigBuilderInterface setErrorBubbling(bool $errorBubbling)

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

FormConfigBuilderInterface setRequired(bool $required)

Устанавливает, обязательно ли заполнять это поле при отправке.

FormConfigBuilderInterface setPropertyPath(null|string|PropertyPathInterface $propertyPath)

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

FormConfigBuilderInterface setMapped(bool $mapped)

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

FormConfigBuilderInterface setByReference(bool $byReference)

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

FormConfigBuilderInterface setInheritData(bool $inheritData)

Устанавливает, должна ли форма читать и записывать данные своего родителя.

FormConfigBuilderInterface setCompound(bool $compound)

Устанавливает, должна ли форма быть составной.

FormConfigBuilderInterface setType(ResolvedFormTypeInterface $type)

Установить типы.

FormConfigBuilderInterface setData(mixed $data)

Устанавливает начальные данные формы.

FormConfigBuilderInterface setDataLocked(bool $locked)

Заблокировать данные формы к данным, переданным в конфигурации.

setFormFactory(FormFactoryInterface $formFactory)

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

FormConfigBuilderInterface setAction(string $action)

Устанавливает целевой URL формы.

FormConfigBuilderInterface setMethod(string $method)

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

FormConfigBuilderInterface setRequestHandler(RequestHandlerInterface $requestHandler)

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

FormConfigBuilderInterface setAutoInitialize(bool $initialize)

Устанавливает, должна ли форма автоматически инициализироваться.

FormConfigInterface getFormConfig()

Строит и возвращает конфигурацию формы.

Подробности

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 Значение параметра.

FormConfigBuilderInterface addEventListener(string $eventName, callable $listener, int $priority)

Добавляет обработчик событий для события на этой форме.

Параметры

string $eventName Имя события, на которое следует подписаться.
callable $listener Обработчик, который нужно выполнить.
int $priority Приоритет обработчика. Обработчики с более высоким приоритетом вызываются перед обработчиками с более низким приоритетом.

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigBuilderInterface addEventSubscriber(EventSubscriberInterface $subscriber)

Добавляет обработчик событий для событий этой формы.

Параметры

EventSubscriberInterface $subscriber Подписчик для добавления.

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigBuilderInterface addViewTransformer(DataTransformerInterface $viewTransformer, bool $forcePrepend = false)

Добавляет/вставляет преобразователь в цепочку преобразователей представления.

Метод transform преобразователя используется для преобразования данных из нормализованного формата в формат представления. Метод reverseTransform преобразователя используется для преобразования данных из формата представления в нормализованный формат.

Параметры

DataTransformerInterface $viewTransformer
bool $forcePrepend если установлено в true, вставка вместо добавления

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigBuilderInterface resetViewTransformers()

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

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigBuilderInterface addModelTransformer(DataTransformerInterface $modelTransformer, bool $forceAppend = false)

Вставляет/добавляет преобразователь в цепочку преобразователей нормализации.

Метод transform преобразователя используется для преобразования данных из модели в нормализованный формат. Метод reverseTransform преобразователя используется для преобразования данных из нормализованного формата в формат модели.

Параметры

DataTransformerInterface $modelTransformer
bool $forceAppend если установлено в true, добавление вместо вставки

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigBuilderInterface resetModelTransformers()

Очищает преобразователи нормализации.

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigBuilderInterface setAttribute(string $name, mixed $value)

Устанавливает значение для атрибута.

Параметры

string $name Имя атрибута
mixed $value Значение атрибута

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigBuilderInterface setAttributes(array $attributes)

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

Параметры

array $attributes Атрибуты.

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigBuilderInterface setDataMapper(DataMapperInterface $dataMapper = null)

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

Параметры

DataMapperInterface $dataMapper

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigBuilderInterface setDisabled(bool $disabled)

Устанавливает, отключена ли форма.

Параметры

bool $disabled Отключена ли форма

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigBuilderInterface setEmptyData(mixed $emptyData)

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

Параметры

mixed $emptyData Пустые данные.

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigBuilderInterface setErrorBubbling(bool $errorBubbling)

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

Параметры

bool $errorBubbling

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigBuilderInterface setRequired(bool $required)

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

Параметры

bool $required

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigBuilderInterface setPropertyPath(null|string|PropertyPathInterface $propertyPath)

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

Параметры

null|string|PropertyPathInterface $propertyPath Путь к свойству или null, если путь должен быть установлен автоматически на основе имени формы.

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigBuilderInterface setMapped(bool $mapped)

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

Параметры

bool $mapped Должна ли форма быть привязана.

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigBuilderInterface setByReference(bool $byReference)

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

Параметры

bool $byReference Должны ли данные изменяться по ссылке.

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigBuilderInterface setInheritData(bool $inheritData)

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

Параметры

bool $inheritData Должна ли форма наследовать данные родителя.

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigBuilderInterface setCompound(bool $compound)

Устанавливает, должна ли форма быть составной.

Параметры

bool $compound Должна ли форма быть составной.

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

FormConfigBuilderInterface Объект конфигурации.

См. также

FormConfigInterface::getCompound()

FormConfigBuilderInterface setType(ResolvedFormTypeInterface $type)

Установить типы.

Параметры

ResolvedFormTypeInterface $type Тип формы.

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigBuilderInterface setData(mixed $data)

Устанавливает начальные данные формы.

Параметры

mixed $data Данные формы в формате приложения.

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigBuilderInterface setDataLocked(bool $locked)

Заблокировать данные формы для данных, переданных в конфигурацию.

Форма с заблокированными данными ограничена данными, переданными в этой конфигурации. Данные можно изменить только путем отправки формы.

Параметры

bool $locked Заблокировать ли данные по умолчанию.

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

FormConfigBuilderInterface Объект конфигурации.

setFormFactory(FormFactoryInterface $formFactory)

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

Параметры

FormFactoryInterface $formFactory Фабрика форм.

FormConfigBuilderInterface setAction(string $action)

Устанавливает целевой URL формы.

Параметры

string $action Целевой URL формы.

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigBuilderInterface setMethod(string $method)

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

Параметры

string $method HTTP-метод формы.

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigBuilderInterface setRequestHandler(RequestHandlerInterface $requestHandler)

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

Параметры

RequestHandlerInterface $requestHandler

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigBuilderInterface setAutoInitialize(bool $initialize)

Устанавливает, должна ли форма инициализироваться автоматически.

Должно быть установлено в true только для корневых форм.

Параметры

bool $initialize True для автоматической инициализации формы, false для подавления автоматической инициализации. В последнем случае необходимо вручную вызвать {@link FormInterface::initialize()}.

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

FormConfigBuilderInterface Объект конфигурации.

FormConfigInterface getFormConfig()

Создаёт и возвращает конфигурацию формы.

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

FormConfigInterface

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Form/FormConfigBuilderInterface.html

Spec-Zone.ru

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