interface/modules/zend_modules/library/Zend/I18n/View/Helper/AbstractTranslatorHelper.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-2015 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\I18n\View\Helper;
  11
  12 use Zend\I18n\Translator\TranslatorInterface as Translator;
  13 use Zend\I18n\Translator\TranslatorAwareInterface;
  14 use Zend\View\Helper\AbstractHelper;
  15
  16 abstract class AbstractTranslatorHelper extends AbstractHelper implements
  17     TranslatorAwareInterface
  18 {
  19     /**
  20      * Translator (optional)
  21      *
  22      * @var Translator
  23      */
  24     protected $translator;
  25
  26     /**
  27      * Translator text domain (optional)
  28      *
  29      * @var string
  30      */
  31     protected $translatorTextDomain = 'default';
  32
  33     /**
  34      * Whether translator should be used
  35      *
  36      * @var bool
  37      */
  38     protected $translatorEnabled = true;
  39
  40     /**
  41      * Sets translator to use in helper
  42      *
  43      * @param  Translator $translator  [optional] translator.
  44      *                                 Default is null, which sets no translator.
  45      * @param  string     $textDomain  [optional] text domain
  46      *                                 Default is null, which skips setTranslatorTextDomain
  47      * @return AbstractTranslatorHelper
  48      */
  49     public function setTranslator(Translator $translator = null, $textDomain = null)
  50     {
  51         $this->translator = $translator;
  52         if (null !== $textDomain) {
  53             $this->setTranslatorTextDomain($textDomain);
  54         }
  55
  56         return $this;
  57     }
  58
  59     /**
  60      * Returns translator used in helper
  61      *
  62      * @return Translator|null
  63      */
  64     public function getTranslator()
  65     {
  66         if (! $this->isTranslatorEnabled()) {
  67             return;
  68         }
  69
  70         return $this->translator;
  71     }
  72
  73     /**
  74      * Checks if the helper has a translator
  75      *
  76      * @return bool
  77      */
  78     public function hasTranslator()
  79     {
  80         return (bool) $this->getTranslator();
  81     }
  82
  83     /**
  84      * Sets whether translator is enabled and should be used
  85      *
  86      * @param  bool $enabled
  87      * @return AbstractTranslatorHelper
  88      */
  89     public function setTranslatorEnabled($enabled = true)
  90     {
  91         $this->translatorEnabled = (bool) $enabled;
  92         return $this;
  93     }
  94
  95     /**
  96      * Returns whether translator is enabled and should be used
  97      *
  98      * @return bool
  99      */
 100     public function isTranslatorEnabled()
 101     {
 102         return $this->translatorEnabled;
 103     }
 104
 105     /**
 106      * Set translation text domain
 107      *
 108      * @param  string $textDomain
 109      * @return AbstractTranslatorHelper
 110      */
 111     public function setTranslatorTextDomain($textDomain = 'default')
 112     {
 113         $this->translatorTextDomain = $textDomain;
 114         return $this;
 115     }
 116
 117     /**
 118      * Return the translation text domain
 119      *
 120      * @return string
 121      */
 122     public function getTranslatorTextDomain()
 123     {
 124         return $this->translatorTextDomain;
 125     }
 126 }