FormConfigBuilder
class FormConfigBuilder implements FormConfigBuilderInterface
Базовая конфигурация формы.
Методы
| __construct(string|int $name, string $dataClass, EventDispatcherInterface $dispatcher, array $options = array()) Создаёт пустую конфигурацию формы. | ||
| 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() Очищает преобразователи нормализации. | |
| 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) Возвращает значение определённой опции. | |
| 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() Создает и возвращает конфигурацию формы. | |
| static | validateName(string|int $name) Проверяет, является ли заданное переменное допустимым именем формы. | |
| static bool | isValidName(string $name) Возвращает, содержит ли заданная переменная допустимое имя формы. |
Подробности
__construct(string|int $name, string $dataClass, EventDispatcherInterface $dispatcher, array $options = array())
Создаёт пустую конфигурацию формы.
Параметры
| string|int | $name | Имя формы |
| string | $dataClass | Класс данных формы |
| EventDispatcherInterface | $dispatcher | Диспечер событий |
| array | $options | Параметры формы |
Исключения
| InvalidArgumentException | Если класс данных не является корректным классом или имя содержит недопустимые символы. |
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 | Объект конфигурации. |
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 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 | Объект конфигурации. |
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 |
FormConfigBuilderInterface validateName(string|int $name)
Проверяет, является ли данная переменная допустимым именем формы.
Параметры
| string|int | $name | Проверяемое имя формы. |
Исключения
| UnexpectedTypeException | Если имя не является строкой или целым числом. |
| InvalidArgumentException | Если имя содержит недопустимые символы. |
static bool isValidName(string $name)
Возвращает, содержит ли данная переменная допустимое имя формы.
Имя принимается, если
- пустое
- начинается с буквы, цифры или подчеркивания
- содержит только буквы, цифры, числа, подчеркивания ("_"), тире ("-") и двоеточия (":")
Параметры
| string | $name | Проверяемое имя формы. |
Возвращаемое значение
| bool | Является ли имя допустимым. |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Form/FormConfigBuilder.html
