Интерфейс FormDataCollectorInterface
интерфейс FormDataCollectorInterface реализует DataCollectorInterface
Сбор и структурирование информации о формах.
Методы
| collect(Request $request, Response $response, Exception $exception = null) Сбор данных для заданного Request и Response. | из DataCollectorInterface | |
| string | getName() Возвращает имя коллектора. | из DataCollectorInterface |
| collectConfiguration(FormInterface $form) Хранит данные конфигурации заданной формы и ее дочерних элементов. | ||
| collectDefaultData(FormInterface $form) Хранит данные по умолчанию заданной формы и ее дочерних элементов. | ||
| collectSubmittedData(FormInterface $form) Хранит данные, отправленные заданной формой и ее дочерними элементами. | ||
| collectViewVariables(FormView $view) Хранит переменные представления заданного представления формы и его дочерних элементов. | ||
| associateFormWithView(FormInterface $form, FormView $view) Указывает, что заданные объекты представляют одну и ту же концептуальную форму. | ||
| buildPreliminaryFormTree(FormInterface $form) Создаёт структуру данных, подобную дереву, на основе собранных данных о заданной форме и ее дочерних элементах. | ||
| buildFinalFormTree(FormInterface $form, FormView $view) Создаёт структуру данных, подобную дереву, на основе собранных данных о заданной форме и ее дочерних элементах. Результат можно запросить с помощью {@link getData()}. | ||
| array | getData() Возвращает все собранные данные. |
Детали
collect(Request $request, Response $response, Exception $exception = null)
Сбор данных для заданного Request и Response.
Параметры
| Request | $request | Экземпляр Request |
| Response | $response | Экземпляр Response |
| Exception | $exception | Экземпляр Exception |
string getName()
Возвращает имя коллектора.
Возвращаемое значение
| string | Имя коллектора |
collectConfiguration(FormInterface $form)
Хранит данные конфигурации заданной формы и ее дочерних элементов.
Параметры
| FormInterface | $form | Корневая форма |
collectDefaultData(FormInterface $form)
Хранит данные по умолчанию заданной формы и ее дочерних элементов.
Параметры
| FormInterface | $form | Корневая форма |
collectSubmittedData(FormInterface $form)
Хранит данные, отправленные заданной формой и ее дочерними элементами.
Параметры
| FormInterface | $form | Корневая форма |
collectViewVariables(FormView $view)
Хранит переменные представления заданного представления формы и его дочерних элементов.
Параметры
| FormView | $view | Корневое представление формы |
associateFormWithView(FormInterface $form, FormView $view)
Указывает, что заданные объекты представляют одну и ту же концептуальную форму.
Параметры
| FormInterface | $form | Объект формы |
| FormView | $view | Объект представления |
buildPreliminaryFormTree(FormInterface $form)
Создаёт структуру данных, подобную дереву, на основе собранных данных о заданной форме и ее дочерних элементах.
Результат можно запросить с помощью {@link getData()}.
Параметры
| FormInterface | $form | Корневая форма |
buildFinalFormTree(FormInterface $form, FormView $view)
Создаёт структуру данных, подобную дереву, на основе собранных данных о заданной форме и ее дочерних элементах.
Результат можно запросить с помощью {@link getData()}.
В отличие от {@link buildPreliminaryFormTree()}, необходимо передать объект {@link FormView}. Структура дерева этого объекта будет использована для структурирования результирующих данных. Это означает, что если дочерний элемент присутствует в представлении, но отсутствует в форме, он всё равно будет присутствовать в массиве конечных данных.
Если в дереве представления присутствуют экземпляры {@link FormView}, для которых не могут быть найдены соответствующие объекты {@link FormInterface} в дереве формы, в результат будут включены только данные представления. В противном случае, если соответствующий {@link FormInterface} существует, вызовите {@link associateFormWithView()} перед вызовом этого метода.
Параметры
| FormInterface | $form | Корневая форма |
| FormView | $view | Корневое представление |
array getData()
Возвращает все собранные данные.
Возвращаемое значение
| array |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/Form/Extension/DataCollector/FormDataCollectorInterface.html