FormDataCollector
class FormDataCollector extends DataCollector implements FormDataCollectorInterface
Сборщик данных для экземпляров {@link FormInterface}.
Свойства
| protected | $data | из DataCollector |
Методы
| serialize() | ||
| unserialize($data) | из DataCollector | |
| Data | cloneVar(mixed $var) Преобразует переменную в экземпляр Data, пригодный для сериализации. | из DataCollector |
| callable[] | getCasters() | |
| __construct(FormDataExtractorInterface $dataExtractor) | ||
| collect(Request $request, Response $response, Exception $exception = null) Не делает ничего. Данные собираются во время прослушивателей событий формы. | ||
| reset() Сбрасывает этот сборщик данных до начального состояния. | ||
| associateFormWithView(FormInterface $form, FormView $view) Указывает, что данные объекты представляют одну и ту же концептуальную форму. | ||
| collectConfiguration(FormInterface $form) Хранит конфигурационные данные заданной формы и ее дочерних элементов. | ||
| collectDefaultData(FormInterface $form) Хранит данные по умолчанию заданной формы и ее дочерних элементов. | ||
| collectSubmittedData(FormInterface $form) Хранит отправленные данные заданной формы и ее дочерних элементов. | ||
| collectViewVariables(FormView $view) Хранит переменные представления заданного представления формы и его дочерних элементов. | ||
| buildPreliminaryFormTree(FormInterface $form) Собирает данные, собранные о заданной форме и ее дочерних элементах, в виде древовидной структуры данных. | ||
| buildFinalFormTree(FormInterface $form, FormView $view) Собирает данные, собранные о заданной форме и ее дочерних элементах, в виде древовидной структуры данных. | ||
| string | getName() Возвращает имя сборщика. | |
| array | getData() Возвращает все собранные данные. |
Подробности
serialize()
unserialize($data)
Параметры
| $data |
protected Данные cloneVar(mixed $var)
Преобразует переменную в экземпляр serializable Data.
Этот массив можно отобразить в шаблоне с помощью компонента VarDumper.
Параметры
| mixed | $var |
Возвращаемое значение
| Данные |
protected callable[] getCasters()
Возвращаемое значение
| callable[] | Конвертеры для добавления к клонеру |
__construct(Интерфейс извлечения данных формы $dataExtractor)
Параметры
| Интерфейс извлечения данных формы | $dataExtractor |
collect(Запрос $request, Ответ $response, Исключение $exception = null)
Не делает ничего. Данные собираются во время слушателей событий формы.
Параметры
| Запрос | $request | |
| Ответ | $response | |
| Исключение | $exception |
reset()
Сбрасывает этот коллектор в исходное состояние.
associateFormWithView(Интерфейс формы $form, Представление формы $view)
Указывает, что данные объекты представляют одну и ту же концептуальную форму.
Параметры
| Интерфейс формы | $form | |
| Представление формы | $view |
collectConfiguration(Интерфейс формы $form)
Хранит данные конфигурации заданной формы и ее дочерних элементов.
Параметры
| Интерфейс формы | $form |
collectDefaultData(Интерфейс формы $form)
Хранит данные по умолчанию для заданной формы и ее дочерних элементов.
Параметры
| Интерфейс формы | $form |
collectSubmittedData(Интерфейс формы $form)
Хранит данные, отправленные с заданной формой и ее дочерними элементами.
Параметры
| Интерфейс формы | $form |
collectViewVariables(Представление формы $view)
Хранит переменные представления для заданного представления формы и его дочерних элементов.
Параметры
| Представление формы | $view |
buildPreliminaryFormTree(Интерфейс формы $form)
Сборка собранных данных о данной форме и ее дочерних элементах в виде древовидной структуры данных.
Результат можно получить с помощью {@link getData()}.
Параметры
| Интерфейс формы | $form |
buildFinalFormTree(Интерфейс формы $form, Представление формы $view)
Сборка собранных данных о данной форме и ее дочерних элементах в виде древовидной структуры данных.
В отличие от {@link buildPreliminaryFormTree()}, необходимо передать объект {@link FormView}. Структура дерева этого объекта представления будет использоваться для структурирования результирующих данных. То есть, если дочерний элемент присутствует в представлении, но не в форме, он будет присутствовать в конечном массиве данных в любом случае.
Если в дереве представлений присутствуют экземпляры {@link FormView}, для которых в дереве формы не найдены соответствующие объекты {@link FormInterface}, в результат будут включены только данные представления. Если соответствующий {@link FormInterface} существует, в противном случае вызовите {@link associateFormWithView()} перед вызовом этого метода.
Параметры
| Интерфейс формы | $form | |
| Представление формы | $view |
string getName()
Возвращает имя коллектора.
Возвращаемое значение
| string | Имя коллектора |
array getData()
Возвращает все собранные данные.
Возвращаемое значение
| array |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Form/Extension/DataCollector/FormDataCollector.html
