Формы¶
Установка¶
Использование¶
Рекомендованный рабочий процесс при работе с формами Symfony, следующий:
Каждый из этих шагов подробно разъясняется в следующих разделах. Чтобы сделать примеры более простыми для понимания, все из них предполагают, что вы создаете небольшое приложение списка дел, отображающее “задачи”.
Этот класс представляет собой обычный PHP-объект, так как на данный момент он не имеет ничего общего с Symfony или какой-либо другой библиотекой. Это обычный PHP-объект, который выполняет задачу непосредственно внутри вашего приложения (т.е. необходимость представления задачи в вашем приложении). Но вы можете редактировать сущности Doctrine таким же образом.
Типы формы¶
Вначале это может показаться запутанным, но вскоре станет естественным. Кроме того, это упрощает код и делает “компоновку” и “встраивание” полей формы намного проще в реализации.
Создание формы¶
Symfony предоставляет объект “конструктора формы”, который позволяет вам описывать поля формы, используя свободный интерфейс. Позже, этот конструктор создает реальный объект формы, используемый для отображения и обработки содержания.
Создание формы в контроллере¶
Создание классов формы¶
Symfony рекомендует размещать минимально возможное количество логики в контроллерах. Вот почему лучше перемещать сложные формы в посвященные им классы, вместо того, чтобы определять их в действиях контроллера. Кроме того, формы, определенные в классах, могут быть использованы повторно в нескольких действиях и сервисах.
Отображение формы¶
В дополнение к темам формы, Symfony позволяет вам настраивать то, как отображаются поля со множеством функций для отображения каждой части поля отдельно (виджеты, ярлыки, ошибки, сообщения помощи, и т.д.)
Обработка формы¶
Обработка формы означает перевод данных, отправленных пользователем, в свойства объекта. Чтобы это произошло, отправленные данные пользователя должны быть записаны в объект формы:
Контроллер следует общему паттерну для обработки форм, и имеет три возможных пути:
Валидация формы¶
До использования валидации, добавьте её поддержку в ваше приложение:
Валидация проводится путем добавления к классу набора правил, под названием (валидация) ограничения. Вы можете добавить их либо к классу сущности, либо к классу формы.
Формы¶
Формы являются одним из наиболее часто неправильно используемых компонентов в связи с их широким применением и бесконечным списком функций. В этой главе мы покажем вам некоторые наилучшие практики, чтобы вы могли использовать преимущества форм для быстрой работы.
Построение форм¶
Определяйте ваши формы как PHP-классы.
Компонент Формы позволяет вам строить формы прямо внутри вашего кода контроллера. Это абсолютно норамльно, если вам не нужно использовать форму повторно где-либо ещё. Но для систематизации и повторного использования мы рекомендуем вам определять каждую форму в собственном PHP-классе:
Чтобы использовать класс, используйте createForm() и передайте полное имя класса:
Конфигурация кнопки формы¶
Классы формы должны пытаться быть независимыми по отношению к тому где они будут использованы. Это делает их повторное использвание позже легче.
Добавляйте кнопки в шаблны, а не в классы форм или контроллеры.
Компонент Форм Symfony позволяет вам добавлять кнопки в качестве полей вашей формы. Это хороший способ упростить шаблон, отображающий вашу форму. Но если вы добавляете кнопки напрямую в ваш класс формы, это сильно ограничит спектр действий этой формы:
Эта форма могла быть создана для написания постов, но если бы вы хотели использовать её повторно для редактирования постов, то ярлык кнопки был бы неверным. Вместо этого, некоторые разрботчики конфигурируют кнопки формы в контроллере:
Это также важная ошибка, так как вы смешиваете разметку презентации (ярлыки, CSS классы и т.д.) с чистым PHP-кодом. Разделение вопросов всегда является хорошей практикой, так что поместите всё, ксающееся просмотра, в слой просмотра:
Отображение формы¶
Существует множество способов отобразить вашу форму, начиная с отображения всего в одной строке, до отображения каждой части каждого поля независимо. Лучший способ зависит от того, какая настраиваемость вам нужна.
Если вам нужно больше контроля над тем, как отображаются ваши поля, то вам стоит удалить функцию form_widget(form) и отобразить ваши поля по-отдельности. См. How to Customize Form Rendering, чтобы узнать больше информации об этом и о том, как вы можете контролировать то как отображается форма на глоабльном уровне, используя тематизацию форм.
Обработка отправок формы¶
Обработка отправки формы обычно следует схожему шаблону:
Эта документация является переводом официальной документации Symfony и предоставляется по свободной лицензии CC BY-SA 3.0.
Компонент Form¶
Установка¶
Также вы можете клонировать репозиторий https://github.com/symfony/form.
If you install this component outside of a Symfony application, you must require the vendor/autoload.php file in your code to enable the class autoloading mechanism provided by Composer. Read this article for more details.
Конфигурация¶
Эта статья объясняет как использовать функции Form как независимого компонента в любом приложении PHP. Прочитайте статью Forms для понимания как использовать его в приложениях Symfony.
В Symfony, формы представлены объектыми, а эти объекты строятся с использованием фабрики форм. Построить фабрику форм просто:
Эта фабрика может уже быть использована для создания базовых форм, но ей не хватает поддержки для очень важных функций:
Следующие разделы объясняют, как подключать эти библиотеки в фабрику форм.
Обработка запросов¶
Чтобы обработать даныные формы, вам понадобится вызвать метод handleRequest() :
Интеграция с компонентом HttpFoundation
Если вы используете компонент HttpFoundation, то вам стоит добавить HttpFoundationExtension в вашу фабрику форм:
Теперь, когда вы обрабатываете форму, вы можете передать объект Request методу handleRequest() :
CSRF-защита¶
Защита от CSRF-атак встроена в компонент Форма, но вам нужно ясно включить её или заменить пользовательским решением. Если вы хотите использовать встроенную поддержку, для начала установите компонент CSRF-защита:
Следующий отрезок добавляет CSRF-защиту к фабрике форм:
Внутренне, это расширение автоматически добавит скрытое поле к каждой форме (по умолчанию названное _token ), значение которой автоматически генерируется CSRF-генератором и валидируется при построении формы.
Вы можете отключить CSRF-защиту для формы используя опцию csrf_protection :
Шаблонизация Twig¶
Если вы используете компонент Форма для обработки HTML форм, то вам понадобится способ с лёгкостью отображать вашу форму в виде полей HTML формы (заполненную значениями полей, ошибками и ярлыками). Если вы используете Twig в качестве шаблонизатора, то компонент Форма предлагает богатую интеграцию.
Чтобы использовать интеграцию, вам понадобится twig bridge, который предоставляет интеграцию между Twig и некоторыми компонентами Symfony:
New in version 1.30: Twig_FactoryRuntimeLoader была представлена в Twig 1.30.
Если вы используете интеграцию Twig, прочтите “ Translation ” ниже, чтобы узнать детали о необходимых фильтрах перевода.
Перевод¶
Если вы используете интеграцию Twig с одним из файлов темы по умолчанию (например, form_div_layout.html.twig ), то существует фильтр Twig ( trans ), который используется для перевода ярлыков, ошибок, опционального текста и других строк формы.
Чтобы использовать встроенную интеграцию, убедитесь в том, что в вашем проекте установлены компоненты Symfony Перевод и Конфигурация :
Далее, добавьте TranslationExtension к вашему экземпляру Twig\Environment :
В зависимости от того, как загружаются ваши переводы, вы можете теперь добавить ключи строк, например, ярлыки полей и их переводы в ваши файлы переводов.
Валидация¶
Чтобы использовать интеграцию с компонентом Symfony Валидатор, для начала убедитесь, что он установлен в вашем приложении:
Ваша интеграция с компонентом Валидация будет выглядеть как-то так:
Доступ к фабрике форм¶
Вашему приложению нужна только одна фабрика форм, и один объект фабрики должен быть использован для создания всех объектов формы в вашем приложении. Это означает, что вам нужно создать его в центральной части изначальной загрузки вашего приложения, а потом получать доступ к нему, когда вам нужно будет строить форму.
Вне зависимости от архитектуры вашего приложения, просто помните, что вам нужно иметь только одну фабрику форм, и что вам нужно иметь к ней доступ во всём своём приложении.
Создание простой формы¶
Установка значений по умолчению¶
Если вам нужно, чтобы ваша форма загружалась с некоторыми значеиями по умолчанию (или если вы строите форму “редактирования”), просто передайте данные по умолчанию при создании вашего конструктора форм:
Отображение формы¶
Изменения метода и действия формы¶
Forms
Forms
Do you prefer video tutorials? Check out the Symfony Forms screencast series.
Creating and processing HTML forms is hard and repetitive. You need to deal with rendering HTML form fields, validating submitted data, mapping the form data into objects and a lot more. Symfony includes a powerful form feature that provides all these features and many more for truly complex scenarios.
Installation
In applications using Symfony Flex, run this command to install the form feature before using it:
Usage
The recommended workflow when working with Symfony forms is the following:
Each of these steps is explained in detail in the next sections. To make examples easier to follow, all of them assume that you’re building a small Todo list application that displays «tasks».
Users create and edit tasks using Symfony forms. Each task is an instance of the following Task class:
This class is a «plain-old-PHP-object» because, so far, it has nothing to do with Symfony or any other library. It’s a normal PHP object that directly solves a problem inside your application (i.e. the need to represent a task in your application). But you can also edit Doctrine entities in the same way.
Form Types
Before creating your first Symfony form, it’s important to understand the concept of «form type». In other projects, it’s common to differentiate between «forms» and «form fields». In Symfony, all of them are «form types»:
Формы в Symfony
В Symfony каждая форма принадлежит конкретной сущности, что даёт нам удобство её обработки. Формы, как и многое другое во фреймворке, можно создавать через консоль. Название формы должно состоять из названия сущности и слова Type (т.е. PostType, UserType). Форму можно создать с помощью компонента maker следующей командой:
Symfony попросит вас ввести имя сущности, с которой связана форма. Введите Post. Дальше у вас сгенерируется папка Form, где вы найдёте класс PostType. Перейдя в него, вы должны увидеть следующий код:
Обратите внимание на то, что классы TextType и TextareaType должны быть загружены по следующим неймспейсам:
Итак, закончив, с созданием формы (да, на этом всё), используем же её для создания первой нашей публикации! Для этого перейдите в класс PostsController.php и создайте метод addPost(). Также не забудьте назначить маршрут нашему методу в аннотации Route и добавить имя.
Строка autowire: true позволяет переложить на Symfony автоматическую загрузку нашего сервиса.
Кстати говоря, эту запись можно убрать
Теперь мы зарегистрировали класс как сервис, а не как аргумент другого класса, в результате чего он стал нам доступен глобально.
Итак, приступим к созданию нашего метода.
Сначала мы создаём объект нашей сущности, которую и будем сохранять.
Дальше мы создаём форму с помощью метода createForm, который обязательным параметром принимает наш класс PostType и объект класса Post.
Теперь мы проверяем, нажата ли кнопка под формой и является ли она валидной в соответствии с теми правилами валидации, которые мы применили к нашей сущности. Если оба этих условия выполняются, мы устанавливаем slug с помощью уже известного нам метода slugify, куда передаём title статьи. Время для поля created_at берём текущее, которое возвращает нам объект класса DateTime() по умолчанию.
Вызываем наш Manager, подготавливаем (persist) и сохраняем пост (flush). После сохранения редиректим пользователя на страницу со всеми постами.
Вот как полностью выглядит наш метод:
Теперь создайте шаблон в папке templates/posts под именем new.html.twig. Всё, что он будет делать, это рендерить форму. Вот как будет выглядеть наш шаблон: