Working with locales

In this example, we get or set locales. We also translate months, languages, regions, etc... And we get numbers in their local format.

Components used in this example

• Zend_Cache
• Zend_Locale
• Zend_Locale_Format
• Zend_Registry

---

MyLocale MyHtml Entry point HTML | Try it | View source code

Working with locales

• We define the list of data with translations.

class MyLocale
{
    // We define the list of data with translations.
    public $transListOptions = array(
        'alpha3toterritory',
        'characters', 'chartofallback', 'citytotimezone', 'currencyfraction',
        'currencyrounding', 'currencysymbol', 'currencytoname', 'currencytoregion',
        'date', 'dateinterval', 'dateitem', 'datetime', 'day', 'days', 'delimiters',
        'era', 'eras', 'fallbacktochar', 'field', 'key',
        'language', 'languagetoscript', 'languagetoterritory', 'layout', 'localeupgrade',
        'measurement', 'month', 'months',
        'nametocurrency', 'numberingsystem', 'numerictoterritory',
        'phonetoterritory', 'postaltoterritory', 'quarter', 'quarters', 'question',
        'regiontocurrency', 'regiontoterritory', 'relative',
        'script', 'scripttolanguage', 'symbols',
        'territory', 'territorytoalpha3', 'territorytolanguage', 'territorytonumeric',
        'territorytophone', 'territorytoregion', 'territorytotimezone',
        'time', 'timezonetocity', 'timezonetoterritory', 'timezonetowindows', 'type',
        'unit', 'variant', 'week', 'windowstotimezone',
    );

Processing the locale

• We get the locale, the method and the action.
• We set the cache.
• We get details on the locale.
• Or we set a default locale.
• Or we translate predefined data.
• Or we convert numbers to a local format.
• If we catch an exception, we return the error message.

    public function process()
    {
        // We get the locale, the method and the action.
        list($locale, $method, $option) = $this->_getParameters();

        try {
            // We set the cache.
            $this->_setCache();

            switch ($method) {
                // We get details on the locale.

                case 'Zend_Locale::findLocale':
                    $result = Zend_Locale::findLocale($locale);
                    break;

                case 'getLanguage':
                case 'getRegion':
                case 'getHttpCharset':
                    $localObj = new Zend_Locale($locale);
                    $result = $localObj->$method();
                    break;

                // Or we set a default locale.

                case 'Zend_Locale::setDefault':
                    Zend_Locale::setDefault($locale);
                    $result = Zend_Locale::getDefault();
                    break;

                case 'Zend_Registry::set':
                    $localObj = new Zend_Locale($locale);
                    Zend_Registry::set('Zend_Locale', $localObj);
                    $result = Zend_Registry::get('Zend_Locale');
                    break;

                // Or we translate predefined data.

                case 'Zend_Locale::getTranslationList':
                    $result = Zend_Locale::getTranslationList($option, $locale);
                    break;

                case 'getQuestion':
                    $localObj = new Zend_Locale();
                    $result = $localObj->getQuestion($locale);
                    break;

                // Or we convert numbers to a local format.

                case 'toInteger':
                case 'toFloat':
                case 'toNumber':
                    $result = Zend_Locale_Format::$method($option,
                        array('locale' => $locale));
                    break;

                default:
                    $result = new Zend_Locale($locale);
            }

        } catch (Exception $e) {
            // If we catch an exception, we return the error message.
            $result = $e->getMessage();
        }

        return array($locale, $method, $option, $result);
    }

Extraction of the parameters from the GET request

    private function _getParameters()
    {
        $locale = empty($_GET['locale'])? null : $_GET['locale'];
        $method = isset($_GET['method'])? $_GET['method'] : null;
        $option = isset($_GET['option'])? $_GET['option'] : null;

        return array($locale, $method, $option);
    }

Setting the cache

    private function _setCache()
    {
        $frontendOptions = array('lifetime' => 3600, 'automatic_serialization' => true);
        $backendOptions = array('cache_dir' => sys_get_temp_dir());
        $cache = Zend_Cache::factory('Core', 'File', $frontendOptions, $backendOptions);
        Zend_Locale::setCache($cache);
    }

}

Displaying items

class MyHtml
{

Displaying the title of the page based on the file name.

    public static function printTitle()
    {
        $basename = basename(__FILE__, '.php');
        $title = ucwords(str_replace('-' , ' ', $basename));
        $zfVersion = Zend_Version::VERSION;
        $phpVersion = phpversion();
        echo "ZfEx $title (ZF/$zfVersion PHP/$phpVersion)";
    }

Displaying the selected option

    public static function printSelected($value, $target)
    {
        $value == $target and print 'selected="selected"';
    }

Colorization of data

• We export the data as valid PHP code.
• We add the PHP tag, we colorize the code, we remove the PHP tag.
• We display the data.

    public static function colorize($mixed)
    {
        // We export the data as valid PHP code.
        $mixed = is_object($mixed)? print_r($mixed, true) : var_export($mixed, true);
        // We add the PHP tag, we colorize the code, we remove the PHP tag.
        $mixed = '<?' . "php $mixed";
        $mixed = highlight_string($mixed, true);
        $mixed = str_replace('&lt;?php&nbsp;', '', $mixed);
        // We display the data.
        echo "<pre>$mixed</pre>";
    }

}

Processing the locale

• We process the locale, and we get the locale, the method, and the option, to display in the form.

// We process the locale, and we get the locale, the method, and the option,
// to display in the form.
$myLocale = new MyLocale();
list($locale, $method, $option, $result) = $myLocale->process();

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title><?php MyHtml::printTitle();?></title>
    <style type="text/css">
      body, td {
          font-family: arial, sans-serif;
          font-size: 0.9em;
      }
    </style>
  </head>

  <body>

    <p>EXAMPLE <?php MyHtml::printTitle();?></p>
    <hr />

    <form name="form">

      <table>

        <tr>
          <td>Locale</td>
          <td>
            <select name="locale">
              <option></option>
              <optgroup label="Zend Locales">
                <option <?php MyHtml::printSelected($locale, 'auto');?>>auto</option>
                <option <?php MyHtml::printSelected($locale, Zend_Locale::BROWSER);?>>
                        <?php echo Zend_Locale::BROWSER;?></option>
                <option <?php MyHtml::printSelected($locale, Zend_Locale::ENVIRONMENT);?>>
                        <?php echo Zend_Locale::ENVIRONMENT;?></option>
              </optgroup>

              <optgroup label="Valid Locales">
                <?php foreach(array_keys(Zend_Locale::getLocaleList()) as $name) :?>
                    <option value="<?php echo $name;?>"
                            <?php MyHtml::printSelected($locale, $name);?>>
                      <?php echo $name;?>
                    </option>
                <?php endforeach;?>
              </optgroup>

              <optgroup label="Invalid Locales">
                <option <?php MyHtml::printSelected($locale, 'fr_US');?>>fr_US</option>
                <option <?php MyHtml::printSelected($locale, 'fr_ZZ');?>>fr_ZZ</option>
                <option <?php MyHtml::printSelected($locale, 'zz');?>>zz</option>
                <option <?php MyHtml::printSelected($locale, 'zz_ZZ');?>>zz_ZZ</option>
                <option <?php MyHtml::printSelected($locale, 'zz_FR');?>>zz_FR</option>
              </optgroup>
            </select>
          </td>
        </tr>

        <tr>
          <td>Method</td>
          <td>
            <select name="method">
              <option></option>

              <optgroup label="Get*">
                <option <?php MyHtml::printSelected($method, 'Zend_Locale::findLocale');?>>
                        Zend_Locale::findLocale</option>
                <option <?php MyHtml::printSelected($method, 'getLanguage');?>>
                        getLanguage</option>
                <option <?php MyHtml::printSelected($method, 'getRegion');?>>
                        getRegion</option>
                <option <?php MyHtml::printSelected($method, 'getHttpCharset');?>>
                        getHttpCharset</option>
              </optgroup>

              <optgroup label="Set*">
                <option <?php MyHtml::printSelected($method, 'Zend_Locale::setDefault');?>>
                        Zend_Locale::setDefault</option>
                <option <?php MyHtml::printSelected($method, 'Zend_Registry::set');?>>
                        Zend_Registry::set</option>
              </optgroup>

              <optgroup label="Translation">
                <option <?php MyHtml::printSelected($method, 'getQuestion');?>>
                        getQuestion</option>
                <option <?php MyHtml::printSelected($method, 'Zend_Locale::getTranslationList');?>>
                        Zend_Locale::getTranslationList</option>
              </optgroup>

              <optgroup label="Localization">
                <option value="toNumber"
                        <?php MyHtml::printSelected($method, 'toNumber');?>>
                        Zend_Locale_Format::toNumber</option>
                <option value="toInteger"
                        <?php MyHtml::printSelected($method, 'toInteger');?>>
                        Zend_Locale_Format::toInteger</option>
                <option value="toFloat"
                        <?php MyHtml::printSelected($method, 'toFloat');?>>
                        Zend_Locale_Format::toFloat</option>
              </optgroup>
              </select>
          </td>
        </tr>

        <tr>
          <td>Option</td>
          <td>
            <select name="option">
              <optgroup label="Zend_Locale::getTranslationList">
                <?php foreach($myLocale->transListOptions as $name) :?>
                    <option value="<?php echo $name;?>"
                            <?php MyHtml::printSelected($option, $name);?>>
                      <?php echo $name;?>
                    </option>
                <?php endforeach;?>
              </optgroup>

              <optgroup label="Zend_Locale_Format::to*">
                <option <?php MyHtml::printSelected($option, '123456789');?>>123456789</option>
                <option <?php MyHtml::printSelected($option, '1234.56789');?>>1234.56789</option>
                <option <?php MyHtml::printSelected($option, '0.123456789');?>>0.123456789</option>
                <option <?php MyHtml::printSelected($option, '1.2345e+6');?>>1.2345e+6</option>
                <option <?php MyHtml::printSelected($option, '-1.2345e-6');?>>-1.2345e-6</option>
              </optgroup>
            </select>
          </td>
        </tr>

        <tr><td>&nbsp;</td></tr>

        <tr>
          <td></td>
          <td>
            <input type="submit" value="Submit" />
          </td>
        </tr>

      </table>
    </form>

    <hr />
    RESULT
    <?php MyHtml::colorize($result);?>

  </body>
</html>