vendor/sulu/sulu/src/Sulu/Component/Localization/Localization.php line 21

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of Sulu.
  5. *
  6. * (c) Sulu GmbH
  7. *
  8. * This source file is subject to the MIT license that is bundled
  9. * with this source code in the file LICENSE.
  10. */
  12. namespace Sulu\Component\Localization;
  14. use JMS\Serializer\Annotation\Groups;
  15. use JMS\Serializer\Annotation\VirtualProperty;
  16. use Sulu\Component\Util\ArrayableInterface;
  18. /**
  19. * Represents a localization of a webspace definition.
  20. */
  21. class Localization implements \JsonSerializable, ArrayableInterface
  22. {
  23. public const UNDERSCORE = 'de_at';
  25. public const DASH = 'de-at';
  27. public const ISO6391 = 'de-AT';
  29. public const LCID = 'de_AT';
  31. /**
  32. * Create an instance of localization for given locale.
  33. *
  34. * @param string $locale
  35. * @param string $format
  36. *
  37. * @return Localization
  38. */
  39. public static function createFromString($locale, $format = self::UNDERSCORE)
  40. {
  41. $delimiter = '-';
  42. if (\in_array($format, [self::UNDERSCORE, self::LCID])) {
  43. $delimiter = '_';
  44. }
  46. $parts = \explode($delimiter, $locale);
  48. $localization = new self(\strtolower($parts[0]));
  49. if (\count($parts) > 1) {
  50. $localization->setCountry(\strtolower($parts[1]));
  51. }
  53. return $localization;
  54. }
  56. /**
  57. * The language of the localization.
  58. *
  59. * @var string
  60. */
  61. #[Groups(['frontend', 'Default'])]
  62. private $language;
  64. /**
  65. * The country of the localization.
  66. *
  67. * @var string
  68. */
  69. #[Groups(['frontend', 'Default'])]
  70. private $country;
  72. /**
  73. * Defines how the generation of shadow pages should be handled.
  74. *
  75. * @var string
  76. */
  77. #[Groups(['frontend', 'Default'])]
  78. private $shadow;
  80. /**
  81. * The sub localizations of this one.
  82. *
  83. * @var Localization[]
  84. */
  85. #[Groups(['frontend', 'Default'])]
  86. private $children = [];
  88. /**
  89. * The parent localization.
  90. *
  91. * @var Localization
  92. */
  93. #[Groups(['frontend', 'Default'])]
  94. private $parent;
  96. /**
  97. * Defines whether this localization is the default one or not.
  98. *
  99. * @var bool
  100. */
  101. #[Groups(['frontend', 'Default'])]
  102. private $default;
  104. /**
  105. * Defines whether this localization is the x-default one or not.
  106. * This will be used to determine the default hreflang tag.
  107. *
  108. * @var bool
  109. *
  110. * @deprecated use $default instead
  111. */
  112. #[Groups(['frontend', 'Default'])]
  113. private $xDefault;
  115. public function __construct($language = null, $country = null)
  116. {
  117. $this->language = $language;
  118. $this->country = $country;
  119. }
  121. /**
  122. * Sets the country of this localization.
  123. *
  124. * @param string $country
  125. */
  126. public function setCountry($country)
  127. {
  128. $this->country = $country;
  129. }
  131. /**
  132. * Returns the country of this localization.
  133. *
  134. * @return string
  135. */
  136. public function getCountry()
  137. {
  138. return $this->country;
  139. }
  141. /**
  142. * Sets the language of this localization.
  143. *
  144. * @param string $language
  145. */
  146. public function setLanguage($language)
  147. {
  148. $this->language = $language;
  149. }
  151. /**
  152. * Returns the language of this localization.
  153. *
  154. * @return string
  155. */
  156. public function getLanguage()
  157. {
  158. return $this->language;
  159. }
  161. /**
  162. * Sets how to handle shadow pages for this localization.
  163. *
  164. * @param string $shadow
  165. */
  166. public function setShadow($shadow)
  167. {
  168. $this->shadow = $shadow;
  169. }
  171. /**
  172. * Returns how to handle shadow pages for this localization.
  173. *
  174. * @return string
  175. */
  176. public function getShadow()
  177. {
  178. return $this->shadow;
  179. }
  181. /**
  182. * Adds a new child localization.
  183. */
  184. public function addChild(self $child)
  185. {
  186. $this->children[] = $child;
  187. }
  189. /**
  190. * Sets the children of the localization.
  191. *
  192. * @param Localization[] $children
  193. */
  194. public function setChildren($children)
  195. {
  196. $this->children = $children;
  197. }
  199. /**
  200. * Returns the children of the localization.
  201. *
  202. * @return Localization[]
  203. */
  204. public function getChildren()
  205. {
  206. return $this->children;
  207. }
  209. /**
  210. * Returns the localization code, which is a combination of the language and the country.
  211. *
  212. * @param string $delimiter between language and country
  213. *
  214. * @return string
  215. *
  216. * @deprecated use getLocale instead
  217. */
  218. #[VirtualProperty]
  219. #[Groups(['frontend', 'Default'])]
  220. public function getLocalization($delimiter = '_')
  221. {
  222. @trigger_deprecation('sulu/sulu', '1.2', __METHOD__ . '() is deprecated and will be removed in 2.0. Use getLocale() instead.');
  224. $localization = $this->getLanguage();
  225. if (null != $this->getCountry()) {
  226. $localization .= $delimiter . $this->getCountry();
  227. }
  229. return $localization;
  230. }
  232. /**
  233. * Returns the localization code, which is a combination of the language and the country in a specific format.
  234. *
  235. * @param string $format requested localization format
  236. *
  237. * @return string
  238. */
  239. #[VirtualProperty]
  240. #[Groups(['frontend', 'Default'])]
  241. public function getLocale($format = self::UNDERSCORE)
  242. {
  243. $localization = \strtolower($this->getLanguage());
  245. if (null != $this->getCountry()) {
  246. $country = \strtolower($this->getCountry());
  247. $delimiter = '-';
  249. switch ($format) {
  250. case self::UNDERSCORE:
  251. $delimiter = '_';
  252. break;
  253. case self::ISO6391:
  254. $country = \strtoupper($country);
  255. break;
  256. case self::LCID:
  257. $delimiter = '_';
  258. $country = \strtoupper($country);
  259. break;
  260. }
  262. $localization .= $delimiter . $country;
  263. }
  265. return $localization;
  266. }
  268. /**
  269. * Sets the parent of this localization.
  270. */
  271. public function setParent(self $parent)
  272. {
  273. $this->parent = $parent;
  274. }
  276. /**
  277. * Returns the parent of this localization.
  278. *
  279. * @return Localization
  280. */
  281. public function getParent()
  282. {
  283. return $this->parent;
  284. }
  286. /**
  287. * Sets if this localization is the default one.
  288. *
  289. * @param bool $default
  290. */
  291. public function setDefault($default)
  292. {
  293. $this->default = $default;
  294. }
  296. /**
  297. * Sets if this localization is the x-default one.
  298. *
  299. * @param bool $xDefault
  300. *
  301. * @deprecated use setDefault to set the default Localization
  302. */
  303. public function setXDefault($xDefault)
  304. {
  305. @trigger_deprecation('sulu/sulu', '2.3', 'The "%s" method is deprecated on "%s" use "setDefault" instead.', __METHOD__, __CLASS__);
  307. $this->xDefault = $xDefault;
  308. }
  310. /**
  311. * Returns if this localization is the default one.
  312. *
  313. * @return bool True if this is the default localization, otherwise false
  314. */
  315. public function isDefault()
  316. {
  317. return $this->default;
  318. }
  320. /**
  321. * Returns if this localization is the x-default one.
  322. *
  323. * @return bool True if this is the x-default localization, otherwise false
  324. *
  325. * @deprecated use getDefault to get the default Localization
  326. */
  327. public function isXDefault()
  328. {
  329. if (\func_num_args() < 1 || \func_get_arg(0)) {
  330. @trigger_deprecation('sulu/sulu', '2.4', 'The "%s" method is deprecated on "%s" use "isDefault" instead.', __METHOD__, __CLASS__);
  331. }
  333. return $this->xDefault;
  334. }
  336. /**
  337. * @param string $localization
  338. *
  339. * @return Localization|null
  340. */
  341. public function findLocalization($localization)
  342. {
  343. if ($this->getLocale() == $localization) {
  344. return $this;
  345. }
  347. $children = $this->getChildren();
  348. if (!empty($children)) {
  349. foreach ($children as $childLocalization) {
  350. $result = $childLocalization->findLocalization($localization);
  351. if ($result) {
  352. return $result;
  353. }
  354. }
  355. }
  357. return;
  358. }
  360. /**
  361. * Returns a list of all localizations and sublocalizations.
  362. *
  363. * @return Localization[]
  364. */
  365. public function getAllLocalizations()
  366. {
  367. $localizations = [];
  368. foreach ($this->getChildren() as $child) {
  369. $localizations[] = $child;
  370. $localizations = \array_merge($localizations, $child->getAllLocalizations());
  371. }
  373. return $localizations;
  374. }
  376. /**
  377. * @return string
  378. */
  379. public function __toString()
  380. {
  381. return $this->getLocale();
  382. }
  384. #[\ReturnTypeWillChange]
  385. public function jsonSerialize()
  386. {
  387. return [
  388. 'localization' => $this->getLocale(),
  389. 'name' => $this->getLocale(),
  390. ];
  391. }
  393. public function toArray($depth = null)
  394. {
  395. $res = [];
  396. $res['country'] = $this->getCountry();
  397. $res['language'] = $this->getLanguage();
  398. $res['localization'] = $this->getLocale();
  399. $res['default'] = $this->isDefault();
  400. $res['xDefault'] = $this->isXDefault(false);
  401. $res['children'] = [];
  403. $children = $this->getChildren();
  404. if ($children) {
  405. foreach ($this->getChildren() as $childLocalization) {
  406. $res['children'][] = $childLocalization->toArray(null);
  407. }
  408. }
  410. $res['shadow'] = $this->getShadow();
  412. return $res;
  413. }
  414. }