Интерфейс FormDataCollectorInterface
интерфейс FormDataCollectorInterface реализует DataCollectorInterface
Собирает и структурирует информацию о формах.
Методы
| collect(Запрос $request, Ответ $response, Исключение $exception = null) Собирает данные для данного запроса и ответа. | из DataCollectorInterface | |
| строка | 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) Сборка данных, собранных о заданной форме и её дочерних элементах, в виде древовидной структуры. | ||
| массив | getData() Возвращает все собранные данные. |
Детали
collect(Запрос $request, Ответ $response, Исключение $exception = null)
Собирает данные для данного запроса и ответа.
Параметры
| Запрос | $request | Экземпляр Request |
| Ответ | $response | Экземпляр Response |
| Исключение | $exception | Экземпляр Exception |
строка getName()
Возвращает имя коллектора.
Возвращаемое значение
| строка | Имя коллектора |
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 | Корневое представление |
массив getData()
Возвращает все собранные данные.
Возвращаемое значение
| массив |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Form/Extension/DataCollector/FormDataCollectorInterface.html