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

  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();
  49.         $localization->setLanguage(\strtolower($parts[0]));
  50.         if (\count($parts) > 1) {
  51.             $localization->setCountry(\strtolower($parts[1]));
  52.         }
  54.         return $localization;
  55.     }
  57.     /**
  58.      * The language of the localization.
  59.      *
  60.      * @var string
  61.      *
  62.      * @Groups({"frontend", "Default"})
  63.      */
  64.     private $language;
  66.     /**
  67.      * The country of the localization.
  68.      *
  69.      * @var string
  70.      *
  71.      * @Groups({"frontend", "Default"})
  72.      */
  73.     private $country;
  75.     /**
  76.      * Defines how the generation of shadow pages should be handled.
  77.      *
  78.      * @var string
  79.      *
  80.      * @Groups({"frontend", "Default"})
  81.      */
  82.     private $shadow;
  84.     /**
  85.      * The sub localizations of this one.
  86.      *
  87.      * @var Localization[]
  88.      *
  89.      * @Groups({"frontend", "Default"})
  90.      */
  91.     private $children;
  93.     /**
  94.      * The parent localization.
  95.      *
  96.      * @var Localization
  97.      *
  98.      * @Groups({"frontend", "Default"})
  99.      */
  100.     private $parent;
  102.     /**
  103.      * Defines whether this localization is the default one or not.
  104.      *
  105.      * @var bool
  106.      *
  107.      * @Groups({"frontend", "Default"})
  108.      */
  109.     private $default;
  111.     /**
  112.      * Defines whether this localization is the x-default one or not.
  113.      * This will be used to determine the default hreflang tag.
  114.      *
  115.      * @var bool
  116.      *
  117.      * @Groups({"frontend", "Default"})
  118.      *
  119.      * @deprecated use $default instead
  120.      */
  121.     private $xDefault;
  123.     public function __construct($language = null, $country = null)
  124.     {
  125.         $this->language = $language;
  126.         $this->country = $country;
  127.     }
  129.     /**
  130.      * Sets the country of this localization.
  131.      *
  132.      * @param string $country
  133.      */
  134.     public function setCountry($country)
  135.     {
  136.         $this->country = $country;
  137.     }
  139.     /**
  140.      * Returns the country of this localization.
  141.      *
  142.      * @return string
  143.      */
  144.     public function getCountry()
  145.     {
  146.         return $this->country;
  147.     }
  149.     /**
  150.      * Sets the language of this localization.
  151.      *
  152.      * @param string $language
  153.      */
  154.     public function setLanguage($language)
  155.     {
  156.         $this->language = $language;
  157.     }
  159.     /**
  160.      * Returns the language of this localization.
  161.      *
  162.      * @return string
  163.      */
  164.     public function getLanguage()
  165.     {
  166.         return $this->language;
  167.     }
  169.     /**
  170.      * Sets how to handle shadow pages for this localization.
  171.      *
  172.      * @param string $shadow
  173.      */
  174.     public function setShadow($shadow)
  175.     {
  176.         $this->shadow = $shadow;
  177.     }
  179.     /**
  180.      * Returns how to handle shadow pages for this localization.
  181.      *
  182.      * @return string
  183.      */
  184.     public function getShadow()
  185.     {
  186.         return $this->shadow;
  187.     }
  189.     /**
  190.      * Adds a new child localization.
  191.      */
  192.     public function addChild(self $child)
  193.     {
  194.         $this->children[] = $child;
  195.     }
  197.     /**
  198.      * Sets the children of the localization.
  199.      *
  200.      * @param Localization[] $children
  201.      */
  202.     public function setChildren($children)
  203.     {
  204.         $this->children = $children;
  205.     }
  207.     /**
  208.      * Returns the children of the localization.
  209.      *
  210.      * @return Localization[]
  211.      */
  212.     public function getChildren()
  213.     {
  214.         return $this->children;
  215.     }
  217.     /**
  218.      * Returns the localization code, which is a combination of the language and the country.
  219.      *
  220.      * @param string $delimiter between language and country
  221.      *
  222.      * @return string
  223.      *
  224.      * @VirtualProperty
  225.      *
  226.      * @Groups({"frontend", "Default"})
  227.      *
  228.      * @deprecated use getLocale instead
  229.      */
  230.     public function getLocalization($delimiter = '_')
  231.     {
  232.         @\trigger_error(__METHOD__ . '() is deprecated since version 1.2 and will be removed in 2.0. Use getLocale() instead.', \E_USER_DEPRECATED);
  234.         $localization = $this->getLanguage();
  235.         if (null != $this->getCountry()) {
  236.             $localization .= $delimiter . $this->getCountry();
  237.         }
  239.         return $localization;
  240.     }
  242.     /**
  243.      * Returns the localization code, which is a combination of the language and the country in a specific format.
  244.      *
  245.      * @param string $format requested localization format
  246.      *
  247.      * @return string
  248.      *
  249.      * @VirtualProperty
  250.      *
  251.      * @Groups({"frontend", "Default"})
  252.      */
  253.     public function getLocale($format = self::UNDERSCORE)
  254.     {
  255.         $localization = \strtolower($this->getLanguage());
  257.         if (null != $this->getCountry()) {
  258.             $country = \strtolower($this->getCountry());
  259.             $delimiter = '-';
  261.             switch ($format) {
  262.                 case self::UNDERSCORE:
  263.                     $delimiter = '_';
  264.                     break;
  265.                 case self::ISO6391:
  266.                     $country = \strtoupper($country);
  267.                     break;
  268.                 case self::LCID:
  269.                     $delimiter = '_';
  270.                     $country = \strtoupper($country);
  271.                     break;
  272.             }
  274.             $localization .= $delimiter . $country;
  275.         }
  277.         return $localization;
  278.     }
  280.     /**
  281.      * Sets the parent of this localization.
  282.      */
  283.     public function setParent(self $parent)
  284.     {
  285.         $this->parent = $parent;
  286.     }
  288.     /**
  289.      * Returns the parent of this localization.
  290.      *
  291.      * @return Localization
  292.      */
  293.     public function getParent()
  294.     {
  295.         return $this->parent;
  296.     }
  298.     /**
  299.      * Sets if this localization is the default one.
  300.      *
  301.      * @param bool $default
  302.      */
  303.     public function setDefault($default)
  304.     {
  305.         $this->default = $default;
  306.     }
  308.     /**
  309.      * Sets if this localization is the x-default one.
  310.      *
  311.      * @param bool $xDefault
  312.      *
  313.      * @deprecated use setDefault to set the default Localization
  314.      */
  315.     public function setXDefault($xDefault)
  316.     {
  317.         @\trigger_error(\sprintf('The "%s" method is deprecated on "%s" use "setDefault" instead.', __METHOD__, __CLASS__), \E_USER_DEPRECATED);
  319.         $this->xDefault = $xDefault;
  320.     }
  322.     /**
  323.      * Returns if this localization is the default one.
  324.      *
  325.      * @return bool True if this is the default localization, otherwise false
  326.      */
  327.     public function isDefault()
  328.     {
  329.         return $this->default;
  330.     }
  332.     /**
  333.      * Returns if this localization is the x-default one.
  334.      *
  335.      * @return bool True if this is the x-default localization, otherwise false
  336.      *
  337.      * @deprecated use getDefault to get the default Localization
  338.      */
  339.     public function isXDefault()
  340.     {
  341.         if (\func_num_args() < 1 || \func_get_arg(0)) {
  342.             @\trigger_error(\sprintf('The "%s" method is deprecated on "%s" use "isDefault" instead.', __METHOD__, __CLASS__), \E_USER_DEPRECATED);
  343.         }
  345.         return $this->xDefault;
  346.     }
  348.     /**
  349.      * @param string $localization
  350.      *
  351.      * @return Localization|null
  352.      */
  353.     public function findLocalization($localization)
  354.     {
  355.         if ($this->getLocale() == $localization) {
  356.             return $this;
  357.         }
  359.         $children = $this->getChildren();
  360.         if (!empty($children)) {
  361.             foreach ($children as $childLocalization) {
  362.                 $result = $childLocalization->findLocalization($localization);
  363.                 if ($result) {
  364.                     return $result;
  365.                 }
  366.             }
  367.         }
  369.         return;
  370.     }
  372.     /**
  373.      * Returns a list of all localizations and sublocalizations.
  374.      *
  375.      * @return Localization[]
  376.      */
  377.     public function getAllLocalizations()
  378.     {
  379.         $localizations = [];
  380.         if (null !== $this->getChildren() && \count($this->getChildren()) > 0) {
  381.             foreach ($this->getChildren() as $child) {
  382.                 $localizations[] = $child;
  383.                 $localizations = \array_merge($localizations, $child->getAllLocalizations());
  384.             }
  385.         }
  387.         return $localizations;
  388.     }
  390.     /**
  391.      * @return string
  392.      */
  393.     public function __toString()
  394.     {
  395.         return $this->getLocale();
  396.     }
  398.     #[\ReturnTypeWillChange]
  399.     public function jsonSerialize()
  400.     {
  401.         return [
  402.             'localization' => $this->getLocale(),
  403.             'name' => $this->getLocale(),
  404.         ];
  405.     }
  407.     public function toArray($depth = null)
  408.     {
  409.         $res = [];
  410.         $res['country'] = $this->getCountry();
  411.         $res['language'] = $this->getLanguage();
  412.         $res['localization'] = $this->getLocale();
  413.         $res['default'] = $this->isDefault();
  414.         $res['xDefault'] = $this->isXDefault(false);
  415.         $res['children'] = [];
  417.         $children = $this->getChildren();
  418.         if ($children) {
  419.             foreach ($this->getChildren() as $childLocalization) {
  420.                 $res['children'][] = $childLocalization->toArray(null);
  421.             }
  422.         }
  424.         $res['shadow'] = $this->getShadow();
  426.         return $res;
  427.     }
  428. }