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