interface/modules/zend_modules/library/Zend/Config/Processor/Translator.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Config\Processor;
  11
  12 use Zend\Config\Config;
  13 use Zend\Config\Exception;
  14 use Zend\I18n\Translator\Translator as ZendTranslator;
  15
  16 class Translator implements ProcessorInterface
  17 {
  18     /**
  19      * @var ZendTranslator
  20      */
  21     protected $translator;
  22
  23     /**
  24      * @var string|null
  25      */
  26     protected $locale = null;
  27
  28     /**
  29      * @var string
  30      */
  31     protected $textDomain = 'default';
  32
  33     /**
  34      * Translator uses the supplied Zend\I18n\Translator\Translator to find
  35      * and translate language strings in config.
  36      *
  37      * @param  ZendTranslator $translator
  38      * @param  string $textDomain
  39      * @param  string|null $locale
  40      */
  41     public function __construct(ZendTranslator $translator, $textDomain = 'default', $locale = null)
  42     {
  43         $this->setTranslator($translator);
  44         $this->setTextDomain($textDomain);
  45         $this->setLocale($locale);
  46     }
  47
  48     /**
  49      * @param  ZendTranslator $translator
  50      * @return Translator
  51      */
  52     public function setTranslator(ZendTranslator $translator)
  53     {
  54         $this->translator = $translator;
  55         return $this;
  56     }
  57
  58     /**
  59      * @return ZendTranslator
  60      */
  61     public function getTranslator()
  62     {
  63         return $this->translator;
  64     }
  65
  66     /**
  67      * @param  string|null $locale
  68      * @return Translator
  69      */
  70     public function setLocale($locale)
  71     {
  72         $this->locale = $locale;
  73         return $this;
  74     }
  75
  76     /**
  77      * @return string|null
  78      */
  79     public function getLocale()
  80     {
  81         return $this->locale;
  82     }
  83
  84     /**
  85      * @param  string $textDomain
  86      * @return Translator
  87      */
  88     public function setTextDomain($textDomain)
  89     {
  90         $this->textDomain = $textDomain;
  91         return $this;
  92     }
  93
  94     /**
  95      * @return string
  96      */
  97     public function getTextDomain()
  98     {
  99         return $this->textDomain;
 100     }
 101
 102     /**
 103      * Process
 104      *
 105      * @param  Config $config
 106      * @return Config
 107      * @throws Exception\InvalidArgumentException
 108      */
 109     public function process(Config $config)
 110     {
 111         if ($config->isReadOnly()) {
 112             throw new Exception\InvalidArgumentException('Cannot process config because it is read-only');
 113         }
 114
 115         /**
 116          * Walk through config and replace values
 117          */
 118         foreach ($config as $key => $val) {
 119             if ($val instanceof Config) {
 120                 $this->process($val);
 121             } else {
 122                 $config->{$key} = $this->translator->translate($val, $this->textDomain, $this->locale);
 123             }
 124         }
 125
 126         return $config;
 127     }
 128
 129     /**
 130      * Process a single value
 131      *
 132      * @param $value
 133      * @return mixed
 134      */
 135     public function processValue($value)
 136     {
 137         return $this->translator->translate($value, $this->textDomain, $this->locale);
 138     }
 139 }