interface/modules/zend_modules/library/Zend/Mvc/Router/Http/TranslatorAwareTreeRouteStack.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\Mvc\Router\Http;
  11
  12 use Zend\I18n\Translator\Translator;
  13 use Zend\I18n\Translator\TranslatorAwareInterface;
  14 use Zend\Stdlib\RequestInterface as Request;
  15
  16 /**
  17  * Translator aware tree route stack.
  18  */
  19 class TranslatorAwareTreeRouteStack extends TreeRouteStack implements TranslatorAwareInterface
  20 {
  21     /**
  22      * Translator used for translatable segments.
  23      *
  24      * @var Translator
  25      */
  26     protected $translator;
  27
  28     /**
  29      * Whether the translator is enabled.
  30      *
  31      * @var bool
  32      */
  33     protected $translatorEnabled = true;
  34
  35     /**
  36      * Translator text domain to use.
  37      *
  38      * @var string
  39      */
  40     protected $translatorTextDomain = 'default';
  41
  42     /**
  43      * match(): defined by \Zend\Mvc\Router\RouteInterface
  44      *
  45      * @see    \Zend\Mvc\Router\RouteInterface::match()
  46      * @param  Request      $request
  47      * @param  integer|null $pathOffset
  48      * @param  array        $options
  49      * @return RouteMatch|null
  50      */
  51     public function match(Request $request, $pathOffset = null, array $options = array())
  52     {
  53         if ($this->hasTranslator() && $this->isTranslatorEnabled() && !isset($options['translator'])) {
  54             $options['translator'] = $this->getTranslator();
  55         }
  56
  57         if (!isset($options['text_domain'])) {
  58             $options['text_domain'] = $this->getTranslatorTextDomain();
  59         }
  60
  61         return parent::match($request, $pathOffset, $options);
  62     }
  63
  64     /**
  65      * assemble(): defined by \Zend\Mvc\Router\RouteInterface interface.
  66      *
  67      * @see    \Zend\Mvc\Router\RouteInterface::assemble()
  68      * @param  array $params
  69      * @param  array $options
  70      * @return mixed
  71      * @throws Exception\InvalidArgumentException
  72      * @throws Exception\RuntimeException
  73      */
  74     public function assemble(array $params = array(), array $options = array())
  75     {
  76         if ($this->hasTranslator() && $this->isTranslatorEnabled() && !isset($options['translator'])) {
  77             $options['translator'] = $this->getTranslator();
  78         }
  79
  80         if (!isset($options['text_domain'])) {
  81             $options['text_domain'] = $this->getTranslatorTextDomain();
  82         }
  83
  84         return parent::assemble($params, $options);
  85     }
  86
  87     /**
  88      * setTranslator(): defined by TranslatorAwareInterface.
  89      *
  90      * @see    TranslatorAwareInterface::setTranslator()
  91      * @param  Translator $translator
  92      * @param  string     $textDomain
  93      * @return TreeRouteStack
  94      */
  95     public function setTranslator(Translator $translator = null, $textDomain = null)
  96     {
  97         $this->translator = $translator;
  98
  99         if ($textDomain !== null) {
 100             $this->setTranslatorTextDomain($textDomain);
 101         }
 102
 103         return $this;
 104     }
 105
 106     /**
 107      * getTranslator(): defined by TranslatorAwareInterface.
 108      *
 109      * @see    TranslatorAwareInterface::getTranslator()
 110      * @return Translator
 111      */
 112     public function getTranslator()
 113     {
 114         return $this->translator;
 115     }
 116
 117     /**
 118      * hasTranslator(): defined by TranslatorAwareInterface.
 119      *
 120      * @see    TranslatorAwareInterface::hasTranslator()
 121      * @return bool
 122      */
 123     public function hasTranslator()
 124     {
 125         return $this->translator !== null;
 126     }
 127
 128     /**
 129      * setTranslatorEnabled(): defined by TranslatorAwareInterface.
 130      *
 131      * @see    TranslatorAwareInterface::setTranslatorEnabled()
 132      * @param  bool $enabled
 133      * @return TreeRouteStack
 134      */
 135     public function setTranslatorEnabled($enabled = true)
 136     {
 137         $this->translatorEnabled = $enabled;
 138         return $this;
 139     }
 140
 141     /**
 142      * isTranslatorEnabled(): defined by TranslatorAwareInterface.
 143      *
 144      * @see    TranslatorAwareInterface::isTranslatorEnabled()
 145      * @return bool
 146      */
 147     public function isTranslatorEnabled()
 148     {
 149         return $this->translatorEnabled;
 150     }
 151
 152     /**
 153      * setTranslatorTextDomain(): defined by TranslatorAwareInterface.
 154      *
 155      * @see    TranslatorAwareInterface::setTranslatorTextDomain()
 156      * @param  string $textDomain
 157      * @return mixed
 158      */
 159     public function setTranslatorTextDomain($textDomain = 'default')
 160     {
 161         $this->translatorTextDomain = $textDomain;
 162
 163         return $this;
 164     }
 165
 166     /**
 167      * getTranslatorTextDomain(): defined by TranslatorAwareInterface.
 168      *
 169      * @see    TranslatorAwareInterface::getTranslatorTextDomain()
 170      * @return string
 171      */
 172     public function getTranslatorTextDomain()
 173     {
 174         return $this->translatorTextDomain;
 175     }
 176 }