Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#6431] changing "Simple Example" to use implode/explode #6581

Closed
Closed
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 19 additions & 27 deletions cookbook/form/data_transformers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,24 @@ to render the form, and then back into a ``DateTime`` object on submit.
When a form field has the ``inherit_data`` option set, Data Transformers
won't be applied to that field.

Simple Example: Sanitizing HTML on User Input
---------------------------------------------
Simple Example: Transforming tags string from User Input to array
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to our headline standards this should be "Simple Example: Transforming String Tags from User Input to an Array".

-----------------------------------------------------------------
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please add a label to be BC with the old headline? This should look like this:

.. _simple-example-sanitizing-html-on-user-input:


Suppose you have a Task form with a description ``textarea`` type::
Suppose you have a Task form with a tags ``text`` type::

// src/AppBundle/Form/TaskType.php
namespace AppBundle\Form\Type;

use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\Component\Form\Extension\Core\Type\TextareaType;
use Symfony\Component\Form\Extension\Core\Type\TextType;

// ...
class TaskType extends AbstractType
{
public function buildForm(FormBuilderInterface $builder, array $options)
{
$builder->add('description', TextareaType::class);
$builder->add('tags', TextType::class);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that we should merge this into the 2.3 branch first. You don't need to create a new PR for this (we can rebase when merging), but can you please change the type here to be simply text (we will then update the type when merging things up)?

}

public function configureOptions(OptionsResolver $resolver)
Expand All @@ -46,15 +46,10 @@ Suppose you have a Task form with a description ``textarea`` type::
// ...
}

But, there are two complications:

#. Your users are allowed to use *some* HTML tags, but not others: you need a way
to call :phpfunction:`strip_tags` after the form is submitted;

#. To be friendly, you want to convert ``<br/>`` tags into line breaks (``\n``) before
rendering the field so the text is easier to edit.
Internally the ``tags`` are stored as an array, but they are displayed
to the user as a simple string, to make them easier to edit.

This is a *perfect* time to attach a custom data transformer to the ``description``
This is a *perfect* time to attach a custom data transformer to the ``tags``
field. The easiest way to do this is with the :class:`Symfony\\Component\\Form\\CallbackTransformer`
class::

Expand All @@ -63,27 +58,24 @@ class::

use Symfony\Component\Form\CallbackTransformer;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Form\Extension\Core\Type\TextareaType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
// ...

class TaskType extends AbstractType
{
public function buildForm(FormBuilderInterface $builder, array $options)
{
$builder->add('description', TextareaType::class);
$builder->add('tags', TextType::class);

$builder->get('description')
$builder->get('tags')
->addModelTransformer(new CallbackTransformer(
// transform <br/> to \n so the textarea reads easier
function ($originalDescription) {
return preg_replace('#<br\s*/?>#i', "\n", $originalDescription);
// transform array to string so the input reads easier
function ($originalTags) {
return implode(', ', $originalTags);
},
function ($submittedDescription) {
// remove most HTML tags (but not br,p)
$cleaned = strip_tags($submittedDescription, '<br><br/><p>');

// transform any \n to real <br/>
return str_replace("\n", '<br/>', $cleaned);
function ($submittedTags) {
// transform the string back to Array
return explode(', ', $submittedTags);
}
))
;
Expand All @@ -106,10 +98,10 @@ in your code.
You can also add the transformer, right when adding the field by changing the format
slightly::

use Symfony\Component\Form\Extension\Core\Type\TextareaType;
use Symfony\Component\Form\Extension\Core\Type\TextType;

$builder->add(
$builder->create('description', TextareaType::class)
$builder->create('tags', TextType::class)
->addModelTransformer(...)
);

Expand Down