pradosoft /
prado
| Total Complexity | 47 |
| Total Lines | 319 |
| Duplicated Lines | 0 % |
| Coverage | 0% |
| Changes | 0 | ||
Complex classes like TGlobalization often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use TGlobalization, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 30 | class TGlobalization extends \Prado\TModule |
||
| 31 | { |
||
| 32 | /** |
||
| 33 | * Default character set is 'UTF-8'. |
||
| 34 | * @var string |
||
| 35 | */ |
||
| 36 | private $_defaultCharset = 'UTF-8'; |
||
| 37 | |||
| 38 | /** |
||
| 39 | * Default culture is 'en'. |
||
| 40 | * @var string |
||
| 41 | */ |
||
| 42 | private $_defaultCulture = 'en'; |
||
| 43 | |||
| 44 | /** |
||
| 45 | * The current charset. |
||
| 46 | * @var string |
||
| 47 | */ |
||
| 48 | private $_charset; |
||
| 49 | |||
| 50 | /** |
||
| 51 | * The current culture. |
||
| 52 | * @var string |
||
| 53 | */ |
||
| 54 | private $_culture; |
||
| 55 | |||
| 56 | /** |
||
| 57 | * Translation source parameters. |
||
| 58 | * @var \Prado\Collections\TMap |
||
| 59 | */ |
||
| 60 | private $_translation; |
||
| 61 | |||
| 62 | /** |
||
| 63 | * @var bool whether we should translate the default culture |
||
| 64 | */ |
||
| 65 | private $_translateDefaultCulture = true; |
||
| 66 | |||
| 67 | /** |
||
| 68 | * @var bool whether the current culture is Right to Left. |
||
| 69 | */ |
||
| 70 | private $_cultureRTL; |
||
| 71 | |||
| 72 | /** |
||
| 73 | * Initialize the Culture and Charset for this application. |
||
| 74 | * You should override this method if you want a different way of |
||
| 75 | * setting the Culture and/or Charset for your application. |
||
| 76 | * If you override this method, call parent::init($xml) first. |
||
| 77 | * @param mixed $config application configuration |
||
| 78 | */ |
||
| 79 | public function init($config) |
||
| 80 | { |
||
| 81 | if ($this->_charset === null) { |
||
| 82 | $this->_charset = $this->getDefaultCharset(); |
||
| 83 | } |
||
| 84 | if ($this->_culture === null) { |
||
| 85 | $this->_culture = $this->getDefaultCulture(); |
||
| 86 | } |
||
| 87 | |||
| 88 | if ($config !== null) { |
||
| 89 | if ($this->getApplication()->getConfigurationType() == TApplication::CONFIG_TYPE_PHP) { |
||
| 90 | $translation = $config['translate'] ?? null; |
||
| 91 | } else { |
||
| 92 | $t = $config->getElementByTagName('translation'); |
||
| 93 | $translation = ($t) ? $t->getAttributes() : null; |
||
| 94 | } |
||
| 95 | if ($translation) { |
||
| 96 | $this->setTranslationConfiguration($translation); |
||
| 97 | } |
||
| 98 | } |
||
| 99 | $this->getApplication()->setGlobalization($this); |
||
| 100 | } |
||
| 101 | |||
| 102 | /** |
||
| 103 | * @return string default culture |
||
| 104 | */ |
||
| 105 | public function getTranslateDefaultCulture() |
||
| 106 | { |
||
| 107 | return $this->_translateDefaultCulture; |
||
|
Bug
Best Practice
introduced
by
|
|||
| 108 | } |
||
| 109 | |||
| 110 | /** |
||
| 111 | * @param bool $value default culture, e.g. <tt>en_US</tt> for American English |
||
| 112 | */ |
||
| 113 | public function setTranslateDefaultCulture($value) |
||
| 114 | { |
||
| 115 | $this->_translateDefaultCulture = TPropertyValue::ensureBoolean($value); |
||
| 116 | } |
||
| 117 | |||
| 118 | /** |
||
| 119 | * @return string default culture |
||
| 120 | */ |
||
| 121 | public function getDefaultCulture() |
||
| 122 | { |
||
| 123 | return $this->_defaultCulture; |
||
| 124 | } |
||
| 125 | |||
| 126 | /** |
||
| 127 | * @param string $culture default culture, e.g. <tt>en_US</tt> for American English |
||
| 128 | */ |
||
| 129 | public function setDefaultCulture($culture) |
||
| 130 | { |
||
| 131 | $this->_defaultCulture = str_replace('-', '_', $culture); |
||
| 132 | } |
||
| 133 | |||
| 134 | /** |
||
| 135 | * @return string default charset set |
||
| 136 | */ |
||
| 137 | public function getDefaultCharset() |
||
| 138 | { |
||
| 139 | return $this->_defaultCharset; |
||
| 140 | } |
||
| 141 | |||
| 142 | /** |
||
| 143 | * @param string $charset default localization charset, e.g. <tt>UTF-8</tt> |
||
| 144 | */ |
||
| 145 | public function setDefaultCharset($charset) |
||
| 146 | { |
||
| 147 | $this->_defaultCharset = $charset; |
||
| 148 | } |
||
| 149 | |||
| 150 | /** |
||
| 151 | * @return string current application culture |
||
| 152 | */ |
||
| 153 | public function getCulture() |
||
| 154 | { |
||
| 155 | return $this->_culture; |
||
| 156 | } |
||
| 157 | |||
| 158 | /** |
||
| 159 | * @param string $culture culture, e.g. <tt>en_US</tt> for American English |
||
| 160 | */ |
||
| 161 | public function setCulture($culture) |
||
| 162 | { |
||
| 163 | if (($culture = str_replace('-', '_', $culture)) != $this->_culture) { |
||
| 164 | $this->_culture = $culture; |
||
| 165 | $this->_cultureRTL = null; |
||
| 166 | } |
||
| 167 | } |
||
| 168 | |||
| 169 | /** |
||
| 170 | * @return string localization charset |
||
| 171 | */ |
||
| 172 | public function getCharset() |
||
| 173 | { |
||
| 174 | return $this->_charset; |
||
| 175 | } |
||
| 176 | |||
| 177 | /** |
||
| 178 | * @param string $charset localization charset, e.g. <tt>UTF-8</tt> |
||
| 179 | */ |
||
| 180 | public function setCharset($charset) |
||
| 181 | { |
||
| 182 | $this->_charset = $charset; |
||
| 183 | } |
||
| 184 | |||
| 185 | /** |
||
| 186 | * @return null|\Prado\Collections\TMap translation source configuration. |
||
| 187 | */ |
||
| 188 | public function getTranslationConfiguration() |
||
| 193 | } |
||
| 194 | |||
| 195 | /** |
||
| 196 | * Sets the translation configuration. Example configuration: |
||
| 197 | * <code> |
||
| 198 | * $config['type'] = 'XLIFF'; //XLIFF, gettext, PHP or Database |
||
| 199 | * $config['source'] = 'Path\to\directory'; // for types XLIFF, PHP and gettext |
||
| 200 | * $config['source'] = 'connectionId'; // for type Database |
||
| 201 | * $config['catalogue'] = 'messages'; //default catalog |
||
| 202 | * $config['autosave'] = 'true'; //save untranslated message |
||
| 203 | * $config['cache'] = 'true'; //cache translated message |
||
| 204 | * $config['marker'] = '@@'; // surround untranslated text with '@@' |
||
| 205 | * </code> |
||
| 206 | * Throws exception is source is not found. |
||
| 207 | * @param array|\Prado\Collections\TMap $config configuration options |
||
| 208 | */ |
||
| 209 | protected function setTranslationConfiguration($config) |
||
| 242 | } |
||
| 243 | |||
| 244 | /** |
||
| 245 | * @return string current translation catalogue. |
||
| 246 | */ |
||
| 247 | public function getTranslationCatalogue() |
||
| 250 | } |
||
| 251 | |||
| 252 | /** |
||
| 253 | * @param string $value update the translation catalogue. |
||
| 254 | */ |
||
| 255 | public function setTranslationCatalogue($value) |
||
| 258 | } |
||
| 259 | |||
| 260 | /** |
||
| 261 | * Gets all the variants of a specific culture. If the parameter |
||
| 262 | * $culture is null, the current culture is used. |
||
| 263 | * @param string $culture the Culture string |
||
| 264 | * @return array variants of the culture. |
||
| 265 | */ |
||
| 266 | public function getCultureVariants($culture = null) |
||
| 277 | } |
||
| 278 | |||
| 279 | /** |
||
| 280 | * Returns a list of possible localized files. Example |
||
| 281 | * <code> |
||
| 282 | * $files = $app->getLocalizedResource("path/to/Home.page","en_US"); |
||
| 283 | * </code> |
||
| 284 | * will return |
||
| 285 | * <pre> |
||
| 286 | * array |
||
| 287 | * 0 => 'path/to/en_US/Home.page' |
||
| 288 | * 1 => 'path/to/en/Home.page' |
||
| 289 | * 2 => 'path/to/Home.en_US.page' |
||
| 290 | * 3 => 'path/to/Home.en.page' |
||
| 291 | * 4 => 'path/to/Home.page' |
||
| 292 | * </pre> |
||
| 293 | * Note that you still need to verify the existance of these files. |
||
| 294 | * @param string $file filename |
||
| 295 | * @param string $culture culture string, null to use current culture |
||
| 296 | * @return array list of possible localized resource files. |
||
| 297 | */ |
||
| 298 | public function getLocalizedResource($file, $culture = null) |
||
| 312 | } |
||
| 313 | |||
| 314 | /** |
||
| 315 | * This returns whether or not the current culture or the specified |
||
| 316 | * culture is right to left orientation. Default $culture is null, which |
||
| 317 | * equal to using $this->Culture as the parameter. |
||
| 318 | * @param null|string $culture, default null which makes this grab the current object culture |
||
| 319 | * @return bool whether or not the specifeid or current culture is right to left |
||
| 320 | * @since 4.2.0 |
||
| 321 | */ |
||
| 322 | public function getIsCultureRTL($culture = null) |
||
| 339 | } |
||
| 340 | |||
| 341 | /** |
||
| 342 | * This hard sets the IsCultureRTL property to the value. |
||
| 343 | * @param bool $rtl whether or not the culture is right to left |
||
| 344 | * @since 4.2.0 |
||
| 345 | */ |
||
| 346 | public function setIsCultureRTL($rtl) |
||
| 351 |
Loading history...
