softspring/doctrine-simple-translation-type-bundle

This package is abandoned and no longer maintained. The author suggests using the softspring/translatable-bundle package instead.

This package provides a simple translation type for doctrine using JSON type.

v5.3.4 2024-10-29 21:21 UTC

Requires

• php: >=8.1
• doctrine/doctrine-bundle: ^2.5
• doctrine/orm: ^2.10 | ^3.0
• symfony/form: ^5.4|^6.0|^7.0
• symfony/http-kernel: ^5.4|^6.0|^7.0
• twig/twig: ^2.0|^3.0

Requires (Dev)

• friendsofphp/php-cs-fixer: 3.64.*
• phpstan/phpstan: ^1.10
• rector/rector: ^1.0

MIT

README

This package provides a simple translation type for Doctrine, and its Symfony integration bundle.

Installation

Applications that use Symfony Flex

Open a command console, enter your project directory and execute:

$ composer require softspring/doctrine-simple-translation-type-bundle

Configure

Configure the Doctrine type:

# config/packages/doctrine.yaml

doctrine:
    dbal:
        types:
            simple_translation: 'Softspring\DoctrineSimpleTranslationTypeBundle\Doctrine\Type\SimpleTranslationType'

Usage

Configure entity that uses the type

use Doctrine\ORM\Mapping as ORM;

/**
 * @var SimpleTranslation
 * @ORM\Column(name="translated_name", type="simple_translation", nullable=false)
 */
protected $translatedName;

public function __construct()
{
    $this->translatedName = new SimpleTranslation();
}
            
/**
 * @return SimpleTranslation
 */
public function getName(): SimpleTranslation
{
    return $this->translatedName;
}

/**
 * @param SimpleTranslation $translatedName
 */
public function setName(SimpleTranslation $translatedName): void
{
    $this->translatedName = $translatedName;
}   

Manage the model

The model class is Softspring\DoctrineSimpleTranslationTypeBundle\Model\SimpleTranslation.

Set the default translation

$entity->getName()->setDefaultLocale('es');
$entity->getName()->setTranslation(null, 'Nombre de la entidad'); // null means default locale
$entity->getName()->setTranslation('es', 'Nombre de la entidad'); // it's also posible to specify the locale

Add additional translations

$entity->getName()->setTranslation('en', 'Entity name');

Get the value

$entity->getName()->translate(); // returns the default value 'Nombre de la entidad'
$entity->getName()->translate('es'); // returns 'Nombre de la entidad'
$entity->getName()->translate('en'); // returns 'Entity name'

Use the full methods

$entity->getName()->getTranslations(); // returns ['es'=>'Nombre de la entidad', 'en'=>'Entity name']
$entity->getName()->setTranslations(['es'=>'Nombre de la entidad', 'en'=>'Entity name']);

Use it as array

The model implements ArrayAccess, so it's possible to use it as an array:

$entity->getName()['en']; // returns 'Entity name'
$entity->getName()['es']; // returns 'Nombre de la entidad'

Twig usage

{{ entity.name|translate }} {# returns 'Nombre de la entidad' if app.request.locale is 'es' #}    
{{ entity.name|translate('es') }} {# returns 'Nombre de la entidad' #}    
{{ entity.name|translate('en') }} {# returns 'Entity name' #}    

Edit values in forms

You can use the Softspring\DoctrineSimpleTranslationTypeBundle\Form\SimpleTranslationType

use Symfony\Component\Form\FormBuilderInterface;

public function buildForm(FormBuilderInterface $builder, array $options)
{
    $builder->add('translatedName'); // automatically uses the SimpleTranslationType thanks to the TypeGuesser
}

Force languages

$builder->add('translatedName', SimpleTranslationType::class, [
    'languages' => ['es','en','de'],    
]);