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