FormDataCollector
class FormDataCollector extends DataCollector implements FormDataCollectorInterface
Сборщик данных для экземпляров {@link FormInterface}.
Методы
| serialize() | ||
| 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 | |
| Response | $response | |
| 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 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.3/Symfony/Component/Form/Extension/DataCollector/FormDataCollector.html