Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\locale;
Chris@0: 
Chris@0: use Drupal\Core\Cache\CacheBackendInterface;
Chris@0: use Drupal\Core\Config\ConfigFactoryInterface;
Chris@0: use Drupal\Core\DestructableInterface;
Chris@0: use Drupal\Core\Language\LanguageInterface;
Chris@0: use Drupal\Core\Language\LanguageManagerInterface;
Chris@0: use Drupal\Core\Lock\LockBackendInterface;
Chris@0: use Drupal\Core\StringTranslation\Translator\TranslatorInterface;
Chris@0: use Symfony\Component\HttpFoundation\RequestStack;
Chris@0: 
Chris@0: /**
Chris@0:  * String translator using the locale module.
Chris@0:  *
Chris@0:  * Full featured translation system using locale's string storage and
Chris@0:  * database caching.
Chris@0:  */
Chris@0: class LocaleTranslation implements TranslatorInterface, DestructableInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * Storage for strings.
Chris@0:    *
Chris@0:    * @var \Drupal\locale\StringStorageInterface
Chris@0:    */
Chris@0:   protected $storage;
Chris@0: 
Chris@0:   /**
Chris@0:    * The configuration factory.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Config\ConfigFactoryInterface
Chris@0:    */
Chris@0:   protected $configFactory;
Chris@0: 
Chris@0:   /**
Chris@0:    * Cached translations.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    *   Array of \Drupal\locale\LocaleLookup objects indexed by language code
Chris@0:    *   and context.
Chris@0:    */
Chris@0:   protected $translations = [];
Chris@0: 
Chris@0:   /**
Chris@0:    * The cache backend that should be used.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Cache\CacheBackendInterface
Chris@0:    */
Chris@0:   protected $cache;
Chris@0: 
Chris@0:   /**
Chris@0:    * The lock backend that should be used.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Lock\LockBackendInterface
Chris@0:    */
Chris@0:   protected $lock;
Chris@0: 
Chris@0:   /**
Chris@0:    * The translate english configuration value.
Chris@0:    *
Chris@0:    * @var bool
Chris@0:    */
Chris@0:   protected $translateEnglish;
Chris@0: 
Chris@0:   /**
Chris@0:    * The language manager.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Language\LanguageManagerInterface
Chris@0:    */
Chris@0:   protected $languageManager;
Chris@0: 
Chris@0:   /**
Chris@0:    * The request stack.
Chris@0:    *
Chris@0:    * @var \Symfony\Component\HttpFoundation\RequestStack
Chris@0:    */
Chris@0:   protected $requestStack;
Chris@0: 
Chris@0:   /**
Chris@0:    * Constructs a translator using a string storage.
Chris@0:    *
Chris@0:    * @param \Drupal\locale\StringStorageInterface $storage
Chris@0:    *   Storage to use when looking for new translations.
Chris@0:    * @param \Drupal\Core\Cache\CacheBackendInterface $cache
Chris@0:    *   The cache backend.
Chris@0:    * @param \Drupal\Core\Lock\LockBackendInterface $lock
Chris@0:    *   The lock backend.
Chris@0:    * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
Chris@0:    *   The config factory.
Chris@0:    * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
Chris@0:    *   The language manager.
Chris@0:    * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
Chris@0:    *   The request stack.
Chris@0:    */
Chris@0:   public function __construct(StringStorageInterface $storage, CacheBackendInterface $cache, LockBackendInterface $lock, ConfigFactoryInterface $config_factory, LanguageManagerInterface $language_manager, RequestStack $request_stack) {
Chris@0:     $this->storage = $storage;
Chris@0:     $this->cache = $cache;
Chris@0:     $this->lock = $lock;
Chris@0:     $this->configFactory = $config_factory;
Chris@0:     $this->languageManager = $language_manager;
Chris@0:     $this->requestStack = $request_stack;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getStringTranslation($langcode, $string, $context) {
Chris@0:     // If the language is not suitable for locale module, just return.
Chris@0:     if ($langcode == LanguageInterface::LANGCODE_SYSTEM || ($langcode == 'en' && !$this->canTranslateEnglish())) {
Chris@0:       return FALSE;
Chris@0:     }
Chris@0:     // Strings are cached by langcode, context and roles, using instances of the
Chris@0:     // LocaleLookup class to handle string lookup and caching.
Chris@0:     if (!isset($this->translations[$langcode][$context])) {
Chris@0:       $this->translations[$langcode][$context] = new LocaleLookup($langcode, $context, $this->storage, $this->cache, $this->lock, $this->configFactory, $this->languageManager, $this->requestStack);
Chris@0:     }
Chris@0:     $translation = $this->translations[$langcode][$context]->get($string);
Chris@0:     return $translation === TRUE ? FALSE : $translation;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Gets translate english configuration value.
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    *   TRUE if english should be translated, FALSE if not.
Chris@0:    */
Chris@0:   protected function canTranslateEnglish() {
Chris@0:     if (!isset($this->translateEnglish)) {
Chris@0:       $this->translateEnglish = $this->configFactory->get('locale.settings')->get('translate_english');
Chris@0:     }
Chris@0:     return $this->translateEnglish;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function reset() {
Chris@0:     unset($this->translateEnglish);
Chris@0:     $this->translations = [];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function destruct() {
Chris@0:     foreach ($this->translations as $context) {
Chris@0:       foreach ($context as $lookup) {
Chris@0:         if ($lookup instanceof DestructableInterface) {
Chris@0:           $lookup->destruct();
Chris@0:         }
Chris@0:       }
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0: }