czwartek, 17 lutego 2011

Internacjonalizcja w CakePHP

Niestety świat się nie kręci wokół javy i czasem trzeba wrócić do starego poczciwego php'a. Szukałem dość długo jak powinna wyglądać poprawna (w kontekście kodu jak i SEO) internacjonalizacja w CakePHP i generalnie w każdym tutorialu czegoś brakowało, coś nie do końca działało, dlatego postarałem się jakoś zebrać tą wiedzę i usystematyzować. Żeby zrozumieć co się dzieje w tutku, trzeba mieć podstawową wiedzę z Caka (wersja 1.2.9), oraz przeczytać rozdział o i18n i l10n z manuala.

1. Na początek radze zapoznać się ze sposobami internacjonalizacji aplikacji, które są dość dobrze opisane tu. Niestety nie stać mnie na różne domeny dla różnych języków (podejście (1)), dlatego wybrałem opcje (2), czyli zróżnicowanie linków pod kątem języków. Generalnie jako piaskownice i poligon doświadczalny postanowiłem zinternacjonalizować swoją bidną stronę domową. Plus będzie tego taki, że wszystkie przykłady będą miały pokrycie na działającym przykładzie.

2. Przyjmuję następującą strukturę linków:

http://www.ludwikowski.info/ - ładuje domyślną stronę w języku polskim

http://www.ludwikowski.info/pol - również ładuje domyślną stronę w języku polskim
http://www.ludwikowski.info/eng - ładuje domyślną stronę w języku angielskim

http://www.ludwikowski.info/pol/pages/display/projects - ładuje wybraną stronę w język polskim
http://www.ludwikowski.info/eng/pages/display/projects - ładuje wybraną stronę w języku angielskim

i teraz pytanie z dziedziny SEO, co z linkami typu:
http://www.ludwikowski.info/pages/display/projects - niby można to obsługiwać domyślnie po polsku, ale nie wiem czy jest sens, dlatego postanowiłem po pierwsze nie generować takich linków, po drugie ich nie obsługiwać. Aczkolwiek, jeśli ktoś ma na ten temat inne zdanie to zapraszam do dyskusji, generalnie zasady SEO są dla mnie czasami dość rozmyte.

3. Wszędzie tam gdzie treść ma być poddana internacjonalizacji używamy funkcji __().

4. Potrzebujemy plików .po, w których będą przechowywane przetłumaczone frazy. Możemy je stworzyć ręcznie, albo użyć jednego z poleceń cakekowych z poziomu konsoli, a konkretnie: cake i18n extract. Polecenie to generuje nam plik .pot będący szablonem na podstawie którego tworzymy już konkretne pliki .po. Czyli w moim przypadku, fragmenty plików .po wyglądają następująco.

app/locale/eng/LC_MESSAGES/default.po

#: \views\elements\rightMenu.ctp:5
msgid "Mój blog"
msgstr "My blog"

#: \views\elements\topMenu.ctp:3
msgid "O mnie"
msgstr "About me"

app/locale/pol/LC_MESSAGES/default.po
#: \views\elements\rightMenu.ctp:5
msgid "Mój blog"
msgstr "Mój blog"

#: \views\elements\topMenu.ctp:3
msgid "O mnie"
msgstr "O mnie"
jeśli zasada tworzenie plików .po nie jest nam znana odsyłam do literatury w necie.

5. Teraz trzeba dostosować aplikację, żeby w miarę wygodnie można było tworzyć linki oraz ich używać. Po pierwsze zasady routingu. W app/config/routes.php umieszczamy (koniecznie przed standardowymi definicjami routtingu!):
//mapowanie na stronę główną po angielsku
Router::connect('/eng', array('language' =>'eng', 'controller' => 'pages', 'action' => 'display', 'home'));
 
//mapowanie na stronę główną po polsku
Router::connect('/pol', array('language' =>'pol', 'controller' => 'pages', 'action' => 'display', 'home'));
 
//pobiera language z np. array('controller'=> 'contacts', 'action' => 'sendEmail', 'language' => 'pol') i umiesza go na początku url'a
Router::connect('/:language/:controller/:action/*', array(), array('language' => '[a-z]{3}'));
Jak dokładnie działa routowanie w cake'u odsyłam do manuala.

6. Należy jakoś zautomatyzować tworzenie linków, żebyśmy nie musieli za każdym razem ręcznie odczytywać (czy to z sesji, czy to z cookie) jaki jest wybrany język i umieszczać go w linku. Dlatego tworzymy app/app_handler i nadpisujemy metodę tworzącą url'e:
class AppHelper extends Helper {
    
    function url($url = null, $full = false) {
        
        if(!isset($url['language'])){
            //sprawdzamy czy jest w coookie
            if (isset($_COOKIE['lang'])){                
                $language=$_COOKIE['lang'];
            }
            //sprawdzamy czy jest w sesji
            if (isset($_SESSION['Config']['language'])){                
                $language=$_SESSION['Config']['language'];        
            }else {
                //jeśli nie ma to domyślnie ustawiamy język polski
                $language='pol';
            }            
            //dodajemy do urla język
            $url['language'] = $language;
        }
        return parent::url($url, $full);
    }
}
Dzięki takiemu zabiegowi możemy tworzyć linki dokładnie tak samo jak to było do tej pory:
echo $html->link(__('Kontakt', true), array('controller'=>'pages', 'action'=>'display', 'contact'));
Język w postaci parametru 'language', będzie dodawany automatycznie.

7. Przechodzimy do dostosowania kontrolera, który będzie przełączał język (na podstawie url'a) jeśli różni się on od obecnie ustawionego. Tworzymy w tym celu odpowiedni komponent app/controllers/components/language.php:
class LanguageComponent extends Object {
    var $name = 'Language';    
    var $components = array('Cookie', 'Session');
    
    //pobiera język z sesji, lub z cookie, lub domyślny = 'pol' jeśli nie był do tej pory ustawiony język 
    function getLanguage(){    
        if ($this->Session->read('Config.language')){
            return $this->Session->read('Config.language');
        }else if ($this->Cookie->check('lang')){
            return $this->Cookie->read('lang');
        }else {
            return 'pol';
        }
    }
    
    // ustawia wybrany język, dodatkowo inicjalizuje parametr w sesji jeśli wygasła 
    function setLanguage($language  = 'pol'){        
        if ($this->Cookie->read('lang') && !$this->Session->check('Config.language')) {
            
            $this->Session->write('Config.language', $this->Cookie->read('lang'));
        }
        else if ($language !=  $this->Session->read('Config.language')) {
            $this->Session->write('Config.language', $language);
            $this->Cookie->write('lang', $language, false, '20 days');
        }
    }
    
    //zmienia $url np.  /eng/controller/action/... na /$lang/controller/action/... 
    function prepareUrl($url, $lang){
        return "/".$lang.substr($url, 4, strlen($url));
    }
}
w app/app_controller.php:
class AppController extends Controller {
    var $components = array('Session', 'Cookie', 'Visit', 'Language');

    function beforeFilter() {        
        $this->set('visitors', $this->Visit->visitCookieUpdate());
        $this->Language->setLanguage($this->_getLanguageFromParams());
    }
    
    function _getLanguageFromParams(){        
        if (isset($this->params['language'])){
            return $this->params['language'];
        }else{
            return 'pol';
        }
    }
}

8. Ok, ogólny kontroler załatwiony, przydałby się jeszcze jakiś, który będzie wymuszał zmianę języka i przenosił na aktualnie oglądaną stronę app/controllers/languages_controller.php:
class LanguagesController extends AppController{    
    var $uses = array();    
    var $components = array('Language');
    
    function change(){        
        $this->redirect($this->Language->prepareUrl($this->referer(), $this->Language->getLanguage()));
    }
}
kontroler jest tak prosty, ponieważ wszystko robi za nas app_controller, język wymuszamy poprzez odpowiedni link. Tak de facto do zadań tego kontrolera należy jedynie przekierowanie na tą samą stronę. Możliwe, że można to jakoś sprawniej załatwić, ale nic mi nie przyszło do głowy, jak ktoś ma pomysł to pisać.
echo $html->link('Polski', array('language' => 'pol', 'controller' => 'languages', 'action' => 'change');

9. Praktycznie to by było na tyle, aczkolwiek żeby mieć już pełny pogląd na sprawy internacjonalizacji, pozostaje ostatni aspekt. Funckja __(), powinna być jedynie zastosowana do krótkich wiadomości. W przypadku potrzeby przetłumaczenia np. całej zawartości paragrafu, należy użyć techniki podmiany widoków, która została opisana w oficjalnym manualu. Niestety pages_controller rządzi się trochę swoimi prawami i oddzielnie dla niego trzeba dorobić jedną rzecz. Ogólnie zastanawiam się, czy nie szybciej byłoby napisać swój własny pages_controller. Moje rozwiązania, które 'łata' pages_controller nie uważam, za zbyt finezyjne, dlatego jak ktoś ma inny pomysł jak to zrobić to z chęcią przeczytam propozycje.

Dorabiamy kolejny komponent pages_i18n:
class PagesI18nComponent extends Object {    
    var $name = 'PagesI18n';    
    var $components = array('Language');
    
    function viewName($viewName){        
        if (file_exists(VIEWS.'pages'.DS.$this->Language->getLanguage().DS.$viewName.'.ctp')){
            
            return $this->Language->getLanguage().DS.$viewName;
        }else{
            return $viewName;
        }
    }
}
w pages_controller wywołujemy podmianę nazwy widoku:
        if (isset($path[0])){            
            $path[0] = $this->PagesI18n->viewName($path[0]);
        }        
        
        $this->set(compact('page', 'subpage', 'title'));
        $this->render(join('/', $path));
a widoki umieszczamy odpowiednio: views/pages/pol/home.ctp, views/pages/eng/home.ctp.

Brak komentarzy:

Publikowanie komentarza