Blame view

vendor/yiisoft/yii2/i18n/MessageSource.php 4.46 KB
abf1649b   andryeyev   Чистая установка ...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
  <?php
  /**
   * @link http://www.yiiframework.com/
   * @copyright Copyright (c) 2008 Yii Software LLC
   * @license http://www.yiiframework.com/license/
   */
  
  namespace yii\i18n;
  
  use Yii;
  use yii\base\Component;
  
  /**
   * MessageSource is the base class for message translation repository classes.
   *
   * A message source stores message translations in some persistent storage.
   *
   * Child classes should override [[loadMessages()]] to provide translated messages.
   *
   * @author Qiang Xue <qiang.xue@gmail.com>
   * @since 2.0
   */
  class MessageSource extends Component
  {
      /**
       * @event MissingTranslationEvent an event that is triggered when a message translation is not found.
       */
      const EVENT_MISSING_TRANSLATION = 'missingTranslation';
  
      /**
       * @var boolean whether to force message translation when the source and target languages are the same.
       * Defaults to false, meaning translation is only performed when source and target languages are different.
       */
      public $forceTranslation = false;
      /**
       * @var string the language that the original messages are in. If not set, it will use the value of
       * [[\yii\base\Application::sourceLanguage]].
       */
      public $sourceLanguage;
  
      private $_messages = [];
  
  
      /**
       * Initializes this component.
       */
      public function init()
      {
          parent::init();
          if ($this->sourceLanguage === null) {
              $this->sourceLanguage = Yii::$app->sourceLanguage;
          }
      }
  
      /**
       * Loads the message translation for the specified language and category.
       * If translation for specific locale code such as `en-US` isn't found it
       * tries more generic `en`.
       *
       * @param string $category the message category
       * @param string $language the target language
       * @return array the loaded messages. The keys are original messages, and the values
       * are translated messages.
       */
      protected function loadMessages($category, $language)
      {
          return [];
      }
  
      /**
       * Translates a message to the specified language.
       *
       * Note that unless [[forceTranslation]] is true, if the target language
       * is the same as the [[sourceLanguage|source language]], the message
       * will NOT be translated.
       *
       * If a translation is not found, a [[EVENT_MISSING_TRANSLATION|missingTranslation]] event will be triggered.
       *
       * @param string $category the message category
       * @param string $message the message to be translated
       * @param string $language the target language
       * @return string|boolean the translated message or false if translation wasn't found or isn't required
       */
      public function translate($category, $message, $language)
      {
          if ($this->forceTranslation || $language !== $this->sourceLanguage) {
              return $this->translateMessage($category, $message, $language);
          } else {
              return false;
          }
      }
  
      /**
       * Translates the specified message.
       * If the message is not found, a [[EVENT_MISSING_TRANSLATION|missingTranslation]] event will be triggered.
       * If there is an event handler, it may provide a [[MissingTranslationEvent::$translatedMessage|fallback translation]].
       * If no fallback translation is provided this method will return `false`.
       * @param string $category the category that the message belongs to.
       * @param string $message the message to be translated.
       * @param string $language the target language.
       * @return string|boolean the translated message or false if translation wasn't found.
       */
      protected function translateMessage($category, $message, $language)
      {
          $key = $language . '/' . $category;
          if (!isset($this->_messages[$key])) {
              $this->_messages[$key] = $this->loadMessages($category, $language);
          }
          if (isset($this->_messages[$key][$message]) && $this->_messages[$key][$message] !== '') {
              return $this->_messages[$key][$message];
          } elseif ($this->hasEventHandlers(self::EVENT_MISSING_TRANSLATION)) {
              $event = new MissingTranslationEvent([
                  'category' => $category,
                  'message' => $message,
                  'language' => $language,
              ]);
              $this->trigger(self::EVENT_MISSING_TRANSLATION, $event);
              if ($event->translatedMessage !== null) {
                  return $this->_messages[$key][$message] = $event->translatedMessage;
              }
          }
  
          return $this->_messages[$key][$message] = false;
      }
  }