Als fervente PHPer kon ik me natuurlijk niet inhouden om die uitbreidingen zelf ook eens te maken, al was het maar om de uitdaging aan te gaan. Bovendien heb ik van elke mensen al vragen gehad over hoe ze eraan moeten beginnen. Daarom heb ik besloten om dit vervolg te schrijven en een woordje uitleg te geven bij deze uitbreidingen.

Meerdimensionale arrays

De uitbreiding die ik heb geschreven ziet er als volgt uit:

function line ($keys, $vals = array())
{
    $return = '';
 
    if (count($vals) === 0)
    {
        // Er zijn geen waardes opgegeven
        // We gebruiken dan een echo
        $return .= 'return $this->language';
    }
    else
    {
        // Er zijn wel waardes opgegeven
        // We gebruiken dan een sprintf
        $return .= 'return sprintf($this->language';
    }
 
    // De volledige key samenstellen aan de hand van de array
    // Dit wordt iets als ['error']['username']['minLength']
    if (is_array($keys) === true)
    {
        // Als $keys een array is halen we alle delen op
        foreach ($keys as &$key)
        {
            $return .= '[\'' . $key . '\']';
        }
    }
    else
    {
        // Anders is er maar één key meegegeven aan de functie
        $return .= '[\'' . $keys . '\']';
    }
 
    // Daarna doen we ongeveer hetzelfde voor de waardes
    // Als die er zijn, maken we gebruik van een sprintf (zie bovenaan)
    if (is_array($vals) === true)
    {
        // Als er een array werd meegegeven, doorlopen we deze
        foreach ($vals as &$val)
        {
            $return .= ', \'' . $val . '\'';
        }
    }
    else
    {
        // Anders is er maar één waarde
        $return .= ', \'' . $vals . '\'';
    }
 
    // Op het einde nog even de functie (echo of sprint) juist afsluiten
    if (count($vals) === 0)
    {
        $return .= ';';
    }
    else
    {
        $return .= ');';
    }
 
    // En het geheel teruggeven
    return eval($return);
}

Deze functie staat uiteraard in het MY_Language.php bestand. Aangezien de naam van de functie die hierboven staat ‘line’ is, zal de functie van CI_Language overschreven worden. Dit is echter geen probleem, omdat onze eigen functie dezelfde en meer functionaliteiten biedt dan de originele. Om dit even te demonstreren, maak ik gebruik van dutch_lang.php in de map language/dutch/:

<?php
$lang['een'] = 'Dit is een voorbeeld';
$lang['twee'] = 'Dit is voorbeeld %s';
$lang['drie']['a'] = 'Dit is voorbeeld a';
$lang['drie']['b'] = 'Dit is voorbeeld b met als gegevens: %s en %s';

De code om dit te testen is redelijk makkelijk te schrijven. Dit zijn enkele van de tests, maar er zijn er natuurlijk nog meer mogelijk. Zo is er bijvoorbeeld geen test voorzien voor een array van keys met één waarde.

<?php
class Home extends Controller
{
    function index()
    {
        $this->lang->load('dutch', 'dutch');
 
        echo $this->lang->line(
            'een'
        );
 
        echo '<br />';
 
        echo $this->lang->line(
            'twee',
            2
        );
 
        echo '<br />';
 
        echo $this->lang->line(
            array('drie', 'a')
        );
 
        echo '<br />';
 
        echo $this->lang->line(
            array('drie', 'b'),
            array('1', '2')
        );
    }
}

Bovenstaande code geeft als resultaat:

Dit is een voorbeeld
Dit is voorbeeld 2
Dit is voorbeeld a
Dit is voorbeeld b met als gegevens: 1 en 2

Dat werkt allemaal heel mooi, maar er is nog een tweede uitdaging.

Alle language file rechtstreeks in de language/ map

Nu staat alle taalbestanden nog in mappen. Zo staat dutch_lang.php in language/dutch/ en english_lang.php in language/english/. Dit heeft als gevolg dat we steeds deze map moeten meegeven met de $this->lang->load functie.

De enige manier om dit op te lossen is om de load functie van CI_Language te overschrijven. Dit kan door de load functie te kopiëren vanuit Language.php (te vinden in system/libraries/) en te plakken in MY_Language.php. Het enige dat je nu nog moet doen is een stuk code in commentaar zetten, of volledig te verwijderen als je dat liever doet. Het gaat om de if structuur die begint op regel 8 van de functie:

if ($idiom == '')
{
    $CI =& get_instance();
    $deft_lang = $CI->config->item('language');
    $idiom = ($deft_lang == '') ? 'english' : $deft_lang;
}

Wanneer je bovenstaande code in commentaar zet kan je in je controllers

$this->lang->load('dutch', 'dutch');

vervangen door

$this->lang->load('dutch');

Je moet natuurlijk ook dutch_lang.php verplaatsen van language/dutch/ naar language/.

En klaar is kees

Voila, beide ideeën die ik en de vorige post voorstelde zijn bij deze gemaakt. Als er nog vrage zijn, je weet ondertussen wel waar je ze kan zetten…

De situatie nu

Wanneer je CodeIgniter download van de website en upload naar je eigen webspace, ben je gebonden aan de 1-dimensionale arrays in language files. Concreet houdt dit in dat je je vertalingen niet kan bundelen. Een kleine language file ziet er bijvoorbeeld zo uit:

1
2
3
4

<?php
$lang['usernameMinLength'] = 'Je gebruikersnaam is niet lang genoeg.';
$lang['usernameMaxLength'] = 'Je gebruikersnaam is te lang.';
$lang['usernameInvalid'] = 'Je gebruikersnaam bevat ongeldige tekens.';

Voor simpele applicaties is dit goed genoeg, maar wanneer je veel teksten hebt die moeten vertaald worden is dit onbegonnen werk. Denk maar eens aan het feit dat je teksten in categorieën wil indelen. Zo wil ik bijvoorbeeld alle foutmeldingen, alle waarschuwingen en alle informatieteksten bij elkaar groeperen. De handleiding van CodeIgniter raad in dat geval het volgende aan:

It’s a good practice to use a common prefix for all messages in a given file to avoid collisions with similarly named items in other files. For example, if you are creating error messages you might prefix them with error_

Dit is weer een leuke oplossing, maar ook niet goed genoeg voor hele grote websites. Een andere oplossing zou zijn om meerdere language files te maken per taal. Zo kan je bijvoorbeeld voor nederlands 3 bestanden aanmaken: nl_foutmeldingen_lang.php, nl_waarschuwingen_lang.php en nl_informatie_lang.php. Ook weer een tof alternatief, maar een oplossing die bijna niet onderhouden is.

Het mag dus wel duidelijk zijn dat er nood is aan een beter oplossing, en die gaan we nu maken.

Hoe het zou moeten

De ideale oplossing zou één bestand per taal zijn, waarin een meerdimensionale array staat die de teksten in categorieën onderverdeeld. Een klein voorbeeldje, in nl_lang.php staat het volgende:

1
2
3
4
5
6
7
8
9

<?php
$lang['error']['usernameMinLength'] = 'Je gebruikersnaam is niet lang genoeg.';
$lang['error']['usernameMaxLength'] = 'Je gebruikersnaam is te lang.';
$lang['error']['usernameInvalid'] = 'Je gebruikersnaam bevat ongeldige tekens.';
 
$lang['warning']['passwordMinLength'] = 'Je wachtwoord is niet lang genoeg.';
$lang['warning']['passwordMinLength'] = 'Je gebruikersnaam is te lang.';
 
$lang['info']['welcome'] = 'Welkom op mijn blog';

Het spreekt voor zich dat in en_lang.php exact hetzelfde staat, maar dan in het engels. Voor de_lang.php, fr_lang.php, etc. is dit uiteraard ook zo. Zoals je kan zien in bovenstaande code, zijn de teksten gegroepeerd. Een array voor alle foutmeldingen, een voor alle waarschuwingen en een voor alle informatieteksten.

Er rest nu nog één probleem. CodeIgniter kan standaard niet om met meerdimensionale arrays in de language files. We moeten dus de language class uitbreiden met een functie die de array wel kan uitlezen.

De oplossing

Wie al een beetje ervaring heeft met CodeIgniter, weet meteen dat voor problemen als deze de ideale oplossing al aanwezig is. Je kan in CI namelijk heel makkelijk bestaande klassen (of libraries in dit geval) overschrijven. Eerst maken we een nieuw bestand aan in /system/application/libraries en we noemen dit MY_Language.php. De inhoud van dit bestand is als volgt:

1
2
3
4
5
6
7
8
9

<?php
class MY_Language extends CI_Language
{
    function line2($array, $line)
    {
        $line = ($line === '' OR $array === '' OR ! isset($this->language[$array][$line])) ? FALSE : $this->language[$array][$line];
        return $line;
    }
}

Aangezien de naam van het bestand MY_ + een_bestaande_klasse is, zal deze automatisch worden geladen door CodeIgniter en moeten we ons hier verder geen zorgen meer om maken. We hebben nu een functie toegevoegd aan de Language klasse van CI, namelijk line2. We geven 2 parameters mee aan deze functie, de array waarin we willen zoeken en de regel die we willen ophalen. Ik heb voor dit voorbeeld deze functie line2 genoemd. In een realistische omgeving zou ik deze functie een kortere naam geven, bijvoorbeeld l2. Zo besparen we onszelf elke keer we deze functie aanroepen weer een beetje werk.

De functie gebruiken kan nu als volgt:

1
2
3
4
5
6
7
8
9
10
11
12

<?php
class Home extends Controller
{
    function index()
    {
        // Eerst laden we het bestand in ('mapnaam', 'bestandsnaam zonder _lang')
        $this->lang->load('dutch', 'dutch');
 
        // Daarna printen we de regel 'usernameMinLength' uit de array 'error'
        echo $this->lang->line2('error', 'usernameMinLength');
    }
}

Wanneer we dan een bezoekje brengen aan home/index krijgen we het volgende resultaat:

1

Je gebruikersnaam is niet lang genoeg.

Exact wat we wilden bereiken. Missie geslaagd.

Noot

De code hierboven is bedoeld als voorbeeld en kan nog heel wat beter geschreven worden. Nu moeten we bijvoorbeeld nog steeds als onze language files in een aparte map plaatsen. dutch_lang.php in language/dutch/, english_lang.php in language/english/. Volgens de zelfde manier als hierboven kan de load functie van de Language klasse overschreven worden zodat we de language files rechtstreeks in language/ mogen plaatsen.

Ook kan de code hierboven worden uitgebreid om ondersteuning te bieden voor meerdimensionale array zodat je nog meer vrijheid krijgt. Beide ideeën laat ik als oefening voor de lezer