Yii 1.1: translate

Module to handle translations
59 followers

Module to handle translations

This extension collects all untranslated messages in the page and then you can add a button to translate, translate automatically using google translate, check for missing translations, edit translations and more.
See github page

Basic usage:

echo Yii::t('app','Some text').' - '.Yii::t('app','some other text');
Yii::app()->translate->editLink('Translate');

Setup

In your config :

<?php
return array(
    'preload'=>array('translate'),//either here or somewhere in the beginning
    //set up and import the module
    'modules'=>array(
        'translate'
    ),
    'import'=>array(
        'application.modules.translate.TranslateModule'
    ),
    'components'=>array(
        //define the class and its missingTranslation event
        'messages'=>array(
            'class'=>'CDbMessageSource',
            'onMissingTranslation' => array('TranslateModule', 'missingTranslation'),
        ),
        'translate'=>array(//if you name your component something else change TranslateModule
            'class'=>'translate.components.MPTranslate',
            //any avaliable options here
            'acceptedLanguages'=>array(
                  'en'=>'English',
                  'pt'=>'Portugues',
                  'es'=>'Español'
            ),
        ),
    )
);

Do not forget to create the tables like described here

the id of message source must be auto-incremental

the name of the tables can be modified

CREATE TABLE SourceMessage
(
    id INTEGER PRIMARY KEY AUTO_INCREMENT,
    category VARCHAR(32),
    message TEXT
);
CREATE TABLE Message
(
    id INTEGER,
    language VARCHAR(16),
    translation TEXT,
    PRIMARY KEY (id, language),
    CONSTRAINT FK_Message_SourceMessage FOREIGN KEY (id)
         REFERENCES SourceMessage (id) ON DELETE CASCADE ON UPDATE RESTRICT
);

How to use

Extract the file to protected/modules

somewhere in your application define the language like the following:

//shortcut
$translate=Yii::app()->translate;
//in your layout add
echo $translate->dropdown();
//adn this
if($translate->hasMessages()){
  //generates a to the page where you translate the missing translations found in this page
  echo $translate->translateLink('Translate');
  //or a dialog
  echo $translate->translateDialogLink('Translate','Translate page title');
}
//link to the page where you edit the translations
echo $translate->editLink('Edit translations page');
//link to the page where you check for all unstranslated messages of the system
echo $translate->missingLink('Missing translations page');

Options avaliable

string $defaultLanguage

defaults language to use if none is set.

if null, it will receive Yii target language

array $dialogOptions

options of the dialog

string $googleApiKey

your google translate api key.

set this if you wish to use googles translate service to translate the messages

array $acceptedLanguages

an array containing the languages accepted by your application.

if not set, it will receive an array containing the target language and the source language

boolean $autoTranslate=false

wheter to auto translate the missing messages found on the page. Needs google api key to set

boolean $autoSetLanguage=true

wheter to automatically set the language on the initialization of the component.

Methods avaliable

for the translate components use it like this:

Yii::app()->translate->someMethod($someArg);

string getLanguage()

Returns the language in use. The language is determined by many variables: session, post, get, header in this order. It will filter the language by using accepted languages. If is set "en_US" and it is not avaliable, then it will check if "en" is avaliable.

string setLanguage($language=null)

If $language is null then it will use getLanguage to determine it. It doesn't check if the language is in the accepted languages. Returns the language setted.

boolean hasMessage()

Return wheter there are messages to be translated in this page

string dropdown()

Returns a dropdown containing all accepted languages with an onchange event that will change the application's language.

string googleTranslate($message,$targetLanguage=null,$sourceLanguage=null)

Translate some message from $sourceLanguage to $targetLanguage using google translate api. Option GoogleApiKey must be defined to use this service.

array getGoogleAcceptedLanguages($targetLanguage=null)

returns an array containing all languages accepted by google translate. Option googleApiKey must be defined to use this service.

string translateLink($label,$type='link')

Generates a link or button to the page where you translate the missing translations found in this page

string translateDialogLink($label,$title=null,$type='link')

Generates a link or button that generates a dialog to the page where you translate the missing translations found in this page.

string editLink($label,$type='link')

Creates a link to the page where you edit the translations.

string missingLink($label,$type='link')

Creates a link to the page where you check all missing translations

type for any link can be 'button' or 'link'

if you are running php 5.3 you can use any method like this MPTranslate::someMethod($someArg);

For the TranslateModule

MPTranslate translator()

returns the translate component

string t($message,$params=array())

used internally for the module to translate its content

string $translateComponentId='translate'

the id of the translate component.

Version

0.2.5 24/07/2014

  • message and categories are now case-insensitive
  • fix page count in missing translate page

0.2.4: 29/08/2011

  • Fixed bug when no translation found.
  • Fixed typos in documentation.
  • Changed file encoding of all files to utf-8

0.2.3: 18/08/2011

  • options languageKey is now a constant named ID
  • Google errors are now logged instead of beeing treated as an exception

0.2.2: 23/05/2011

  • Fixed pagination in dialog and textarea size

0.2.1: 20/05/2011

  • Fixed some minor bugs

0.2: 18/05/2011

  • complete rewrite of the code to allow easier customization
  • added google translate support (thanks to Toshi)
  • added defaultLanguage (thanks to duna)
  • fixed a couple of minor bugs
  • added a lof of new funcionalities

0.1: 10/05/2011

-first release

Resources

Get a google API key

CDbMessageSource

Forum support

GitHub repository

Notes

This module will slow down your application, use it for development only

It's not fully tested. I'm expecting your feedback to improve it

Total 20 comments

#17839 report it
Yatin Mistry at 2014/07/28 07:37am
Need some examples how to use it

Need some examples how to use it.

Please share some examples how can we use it in model, view and controller?

#17820 report it
Rajith R at 2014/07/25 12:48am
@Gustavo

Started .

https://github.com/gusnips/yii.translate/issues/6

#17814 report it
Gustavo at 2014/07/24 09:27am
@Rajith R

Please open a bug at github so I can take a look whenever I have some time

Link: https://github.com/gusnips/yii.translate/issues

Thanks for the feedback, though!

#17813 report it
Rajith R at 2014/07/24 09:20am
@Gustavo

I replaced the file , but Pagination is not showing.

#17812 report it
Gustavo at 2014/07/24 09:05am
@Rajith R

yes, that's it

#17811 report it
Rajith R at 2014/07/24 08:51am
Cool

Thank you. So we just need to replace that file. right?

#17810 report it
Gustavo at 2014/07/24 08:39am
@Rajith R

Only components/MPTranslate.php was changed

#17809 report it
Rajith R at 2014/07/24 08:31am
Which are the files to replace?

Thanks Gustavo . Which are the files to replace? Please let us know.

#17807 report it
Gustavo at 2014/07/24 08:20am
@Rajith R

I just added. Thanks for the reminder

#17806 report it
Rajith R at 2014/07/24 08:13am
@Gustavo

what are the changes/upgrades in the new version?

#17001 report it
Nabi at 2014/04/21 08:02pm
bug in case insensitive words

4- I find a bug, the missingTranslation() function is not case insensitive, so if exist a record with name "By" and translated it, then if use Yii::t('main', 'by'); don't show translated "By" and also don't add record "by" for new translate!

#16792 report it
Gustavo at 2014/03/28 12:29am
@Nabi

1-It doesn't have this ability yet. Could you open a ticket in github page? As soon as I have time I'll implement it.

2-For none of those pages? It should have. It showed to me last time I check. I'll take a look around and get back to you

3-You are probably right! I actually didn't check this scenario but the logic is right. I usually use only in development and enable it in admin application

#16783 report it
Nabi at 2014/03/27 06:14am
about slow

3- Note about your last paragraph that you said this module is slow, I against with this subject! Note that when exist missing translated word, execute one query for each Yii:t, and this is correct and was slow, But If you do translate all words in all language, so don't execute addition query and was fast.

#16782 report it
Nabi at 2014/03/27 06:14am
bug in show pagination

2- The pagination of translate/edit/missing page, didn't show! I thinks it's a bug.

#16781 report it
Nabi at 2014/03/27 06:14am
how store all messages in database

Thanks for great module.

1- In here when visit a page, store all words(in current page) of Yii::t in database, but how can store all words of all .php files in database just by one click, be like yiic message messages/config.php command.

#15781 report it
dacoder at 2013/12/16 03:37pm
not able to translate all the components of the page

Is it possible to translate the whole page without using Yii::t on each content type ? I was hoping for something that works on the lines of me selecting a language and the whole page showing translated to the selected language.

#15250 report it
Rajith R at 2013/10/21 03:34am
@Shahcheraghean

translate/edit

and

translate/edit/missing

are two important actions!

#15249 report it
Rajith R at 2013/10/21 03:32am
@Shahcheraghean

to set language dynamically

$lan='en_us';
Yii::app()->translate->setLanguage($lan);

You set $lan according your wish at main layout or somewhere else!!

#15248 report it
Shahcheraghean at 2013/10/21 03:18am
@Rajith R

Yes please, Usage and configurations?! So Thanks.

#15246 report it
Rajith R at 2013/10/21 02:11am
@Shahcheraghean

Usage examples?

Leave a comment

Please to leave your comment.

Create extension