bushbaby/bsb-doctrine-translator

BsbDoctrineTranslator is a ZF2 module that provides tools to manage translations stored with doctrine.

1.0.0-alpha2 2015-04-03 21:06 UTC

README

WARNING! very much work in progress - do not use in production!

Set of tools to manage translation from a doctrine database.

Installation

as zf2 project

BsbDoctrineTranslator works with Composer. To install it into your project, just add the following line into your composer.json file:

"require": {
    "bushbaby/bsb-doctrine-translator": "~1.0.0@dev"
}

Then update your project by runnning composer.phar update.

Finally enable the module by adding BsbDoctrineTranslator in your application.config.php file.

as standalone

For development purposes you might want to install BsbDoctrineTranslator standalone. Clone the project somewhere on your computer

git clone git@github.com:bushbaby/BsbDoctrineTranslator.git BsbDoctrineTranslator
cd BsbDoctrineTranslator
curl -sS https://getcomposer.org/installer | php
git checkout develop
./composer.phar install
phpunit

Configuration

To configure the module just copy the bsb_doctrine_translator.local.php.dist (you can find this file in the config folder of BsbDoctrineTranslator) into your config/autoload folder, and override what you want.

Commandline Tool

Commands

The source scanner provides the ability to detect any translate(message, domain, locale) translatePlural(message, plural, number, domain, locale) invokations in PHP source.

scan-source accepts these arguments

--locale 
--domain 
--file=path/to/file
--kind=all|singular|plural defaults to all

To list detected messages

scan-source list 

Export detected messages

scan-source export > exported.txt

The comparison component provides the ability to compare message defined in source to the actual translation in the database

Provides the ability to compare the message found in source to messages stored in database
  
compare untranslated

Features (some planned)

  • Warn against missing printf tokens in plural messages
  • Warn against conflicting singular and plural message (since these should never be the same)
  • Find messages without a translation
  • Remove messages defined in database but not detected in source
  • Add messages defined in source but not present in database
  • Exporting to various formats
  • Change a translation
  • Detect a translation invokation that has moved due to refactoring
  • Detect a change of message refactoring
  • Display the source context of a message