gupalo/symfony-form-transformers

Symfony Form Transformers

1.3.0 2024-02-21 16:44 UTC

Requires

• php: >=8.1
• symfony/form: ^6.1|^7.0
• symfony/yaml: ^6.1|^7.0

Requires (Dev)

• phpspec/prophecy-phpunit: ^2.0
• phpunit/phpunit: ^10.5

MIT

• Volodymyr Luchaninov

• symfony
• form
• tsv
• data-transformer

README

Symfony Forms TsvTransformer

How to Install

Install the gupalo/symfony-form-transformers package using composer:

composer require gupalo/symfony-form-transformers

Transformers

• EmptyStringTransformer: allows user to pass empty fields which should be empty strings instead of null
• JsonYamlTransformer: user views and edits field as YAML but it is stored as JSON in DB and is array in PHP
• StringArrayTransformer: user can enter several strings each from new line and they will become an array
• TsvTransformer: user copy-pastes from spreadsheet and PHP gets array with named keys (multiline and quoting are not supported)

Basic Usage

Add transformers to your forms

class YourEntity
{
    private ?array $data = [];
}
///
class YourEntityType extends AbstractType
{
    public function __construct(private JsonYamlTransformer $jsonYamlTransformer)
    {
        $this->jsonYamlTransformer = $jsonYamlTransformer;
    }

    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder
            // ...
            ->add('data', TextareaType::class);

        $builder->get('data')->addModelTransformer($this->jsonYamlTransformer);
    }

Advanced Usage

Some transformers have options on construct. Options are public properties, you can change them later.

See tests for more examples. Also look at src - the logic is quite simple.

If you have multiline input Tsv, set TsvHelper::$multiline = true;