/EasyTranslation

Primary LanguagePHP

Essedi

EasyTranslator

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: Adds repo to composer repository
For use:

 "repositories": 
            [
                {
                    "type": "composer",
                    "url": "https://php.fury.io/essedi"
                }
            ],

For use and develop:

"repositories": [
        {
            "type": "vcs",
            "url": "git@github.com:essedi/EasyTranslation.git"
        }
    ],
$ composer require Essedi\EasyTranslator

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

Once, you have registered the bundle, you need to install CKEditor:

$ php bin/console ckeditor:install

Once, you have downloaded CKEditor, you need to install it in the web directory.

$ php bin/console assets:install public

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
////config/bundles.php
return [
...
    Essedi\EasyTranslation\EssediEasyTranslationBundle::class => ['all' => true],
];

Step 3: Copy Configs

Services

<?php
////App/config/services.php
services:
     Essedi\EasyTranslation\EventSubscriber\TranslatableSubscriber:
        arguments: 
            - '@annotation_reader'
            - '@request_stack'
            - '%kernel.default_locale%'
        tags:
            - { name: doctrine.event_listener, event: postLoad}
            - { name: doctrine.event_listener, event: prePersist}
            - { name: doctrine.event_listener, event: preUpdate}

            
    Essedi\EasyTranslation\Annotation\Driver\AnnotationDriver:
        class: Essedi\EasyTranslation\Annotation\Driver\AnnotationDriver
        tags: 
            - {name: kernel.event_listener, event: kernel.controller, method: onKernelController}
        arguments: ["@annotation_reader"]

Twing config

Only if want integrate with EasyAdmin

<?php
////App/config/packages/twing.php
twig:
    paths: 
        "%kernel.project_dir%/vendor/Essedi/EasyTranslation/src/Resources/views": EssediEasyTranslation
    debug: '%kernel.debug%'
    strict_variables: '%kernel.debug%'
    form_themes:
        - '@EssediEasyTranslation/easy_admin/translation.html.twig'

Step 4: Set Entity for translate

add uses

<?php
////App/Entity/YourEntity.php

You need to set the Entity like translatable

use Essedi\EasyTranslation\Entity\Translation;
use Essedi\EasyTranslation\Annotation as Essedi;
use Essedi\EasyTranslation\Annotation\Translatable;
use Essedi\EasyTranslation\Annotation\TranslateMe;

add Annotations

class annotation

<?php
/*
 * @Essedi\Translatable
 */

property annotation

<?php
/*
 * @Essedi\TranslateMe(type="text")
 */

Attributes:

  • type:
    • text : default value
    • textarea
    • checkbox
    • number (Working)
    • date (Working)
    • email (Working)
    • password (Working)
    • color (Working)
    • ckeditor
* label:  Use name by default

* config: array of configs values

extend class

<?php
	class YourEntity extends Translation

Step 5: Set EasyAdminSubscriber

Only if want integrate with EasyAdmin

<?php
////App/EventSubscriber/EasyAdminSubscriber.php
namespace App\EventSubscriber;

use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\EventDispatcher\GenericEvent;
use Essedi\EasyTranslation\Entity\Translation;
use EasyCorp\Bundle\EasyAdminBundle\Event\EasyAdminEvents;
use Doctrine\Common\Annotations\Reader;

class EasyAdminSubscriber implements EventSubscriberInterface
{

    /**
     *
     * @var Reader 
     */
    private $annotationReader;

    public function __construct(Reader $annotationReader)
    {
        $this->annotationReader = $annotationReader;
    }

    public static function getSubscribedEvents()
    {
        return array(
            EasyAdminEvents::PRE_PERSIST => array('editTranslatable'),
            EasyAdminEvents::PRE_UPDATE => array('editTranslatable')
        );
    }

     public function editTranslatable(GenericEvent $event)
    {

        $args          = $event->getArguments();
        $requestParams = $args["request"]->request->all();

        $entity = $event->getSubject();
        if ($entity instanceof Translation)
        {
            $this->setTranslations($requestParams, $entity);
            foreach ($requestParams as $data)
            {
                $this->setTranslations($data, $entity);
            }
        }
    }

    protected function setTranslations($data, $entity)
    {
        if (isset($data["translations"]))
        {
            $translations = [];
            $newlocale    = null;
            foreach ($data["translations"] as $field => $value)
            {
                if (!is_array($value))
                {
                    if ($field !== "newlocale")
                    {
                        $fieldData   = explode('-', $field);
                        $fieldLocale = $fieldData[0];

                        $fieldName  = $fieldData[1];
                        $fieldType  = $fieldData[2];
                        $fieldValue = $value;
                        if (!isset($translations[$fieldLocale]))
                        {
                            $translations[$fieldLocale] = [];
                        }
                        $translations[$fieldLocale][$fieldName] = $fieldValue;
                    }
                }
                else
                {
                    if (!isset($translations[$field]))
                    {
                        $translations[$field] = [];
                    }
                    $translations[$field] = $value;
                }

                if ($field == "newlocale")
                {
                    $newlocale = $value;
                }
            }
            if ($newlocale)
            {
                $translations = $this->setLocaleKey($translations, $newlocale);
            }
            $entity->setTranslations($translations);
        }
    }

    function setLocaleKey($translations, $locale)
    {
        if (!array_key_exists("new", $translations))
        {
            return $translations;
        }
        $keys                             = array_keys($translations);
        $keys[array_search("new", $keys)] = $locale;
        return array_combine($keys, $translations);
    }


}

Step 6: Set EasyAdmin form fields translatables

Only if want integrate with EasyAdmin

You can set Translatable form on you EasyAdmin adding this code on your entity fields

		- property: translations
                  label: 'translatables'
                  type: 'Essedi\EasyTranslation\Resources\Form\Type\TranslationType'

Credits

Created by: