simettric/doctrine-translatable-form-bundle

0.1.5 2017-09-18 18:58 UTC

README

The goal of this Symfony Bundle is simplify the creation of translatable forms using Gedmo Doctrine Extensions and StofDoctrineExtensionsBundle.

Installation

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require simettric/doctrine-translatable-form-bundle 

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the app/AppKernel.php file of your project:

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...
            new Stof\DoctrineExtensionsBundle\StofDoctrineExtensionsBundle(),
            new Simettric\DoctrineTranslatableFormBundle\SimettricDoctrineTranslatableFormBundle(),
        );

        // ...
    }

    // ...
}

Configuration

You must to activate the persist_default_translation key in your stof_doctrine_extensions configuration options

#app/config/config.yml
stof_doctrine_extensions:
    default_locale: %locale%
    translation_fallback: true
    persist_default_translation: true
    orm:
        default:
            translatable: true

Configure the view

This bundle implements the Bootstrap Tabs component in order to show the different locale inputs for each field.

If you want to use it, just add the template in the form_themes section in your Twig configuration. Obviously, the bootstrap assets must be loaded in your layout.

# app/config/config.yml
twig:
    ...
    form_themes:
        - 'SimettricDoctrineTranslatableFormBundle:Form:fields.html.twig'

Creating your forms

This is a simple example showing how you can code your translatable forms

<?php

namespace AppBundle\Form;


use Simettric\DoctrineTranslatableFormBundle\Form\AbstractTranslatableType;
use Simettric\DoctrineTranslatableFormBundle\Form\TranslatableTextType;

class CategoryType extends AbstractTranslatableType
{
    /**
     * @param FormBuilderInterface $builder
     * @param array $options
     */
    public function buildForm(FormBuilderInterface $builder, array $options)
    {

        // you can add the translatable fields
        $this->createTranslatableMapper($builder, $options)
             ->add("name", TranslatableTextType::class)
             ->add("description", TranslatableTextareaType::class)
        ;

        // and then you can add the rest of the fields using the standard way
        $builder->add('enabled')
        ;

    }
    
    /**
     * @param OptionsResolver $resolver
     */
    public function configureOptions(OptionsResolver $resolver)
    {

        $resolver->setDefaults(array(
            'data_class'   => 'AppBundle\Entity\Category'
        ));

        // this is required
        $this->configureTranslationOptions($resolver);

    }
}

Then you need to declare your form type as a service

#app/config/services.yml

parameters:
    locale: es
    locales: [es, eu, en, fr]

services:
    app.form.category_type:
        class: AppBundle\Form\CategoryType
        arguments: ["@sim_trans_form.mapper"]
        calls:
            - [ setRequiredLocale, [%locale%] ]
            - [ setLocales, [%locales%] ]
        tags:
            - { name: form.type }

And now you can work in your controller as if you worked with normal entities

$category = new Category();

$form = $this->createForm(CategoryType::class, $category);

if($request->getMethod() == "POST"){

    $form->handleRequest($request);
    
    if($form->isValid()){
    
        $em = $this->getDoctrine()->getManager();
        
        $em->persist($category);
        $em->flush();
    
    }
}

You can set your own Repository defining a new custom mapping service. This is useful for instance when you have a Personal Translation mapping configuration using a specific translation repository

services:
    app.my_custom_mapper:
        class:     Simettric\DoctrineTranslatableFormBundle\Form\DataMapper
        arguments: ["@doctrine.orm.entity_manager", "AppBundle\Repository\PostTranslationRepository"]
        
    app.form.post_type:
        class: AppBundle\Form\PostType
        arguments: ["@app.my_custom_mapper"]
        calls:
            - [ setRequiredLocale, [%locale%] ]
            - [ setLocales, [%locales%] ]
        tags:
            - { name: form.type }

If you have configured the Bootstrap Tabs theme in your Twig configuration, you can show your fields with the Boo in the templates with the form_row tag

<div class="form-group">
    {{ form_row(form.name, {label: "name"|trans}) }}
</div>

<div class="form-group">
    {{ form_row(form.description, {label: "description"|trans}) }}
</div>