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.      * @Groups({"frontend", "Default"})
  226.      *
  227.      * @deprecated use getLocale instead
  228.      */
  229.     public function getLocalization($delimiter = '_')
  230.     {
  231.         @trigger_deprecation('sulu/sulu', '1.2', __METHOD__ . '() is deprecated and will be removed in 2.0. Use getLocale() instead.');
  233.         $localization = $this->getLanguage();
  234.         if (null != $this->getCountry()) {
  235.             $localization .= $delimiter . $this->getCountry();
  236.         }
  238.         return $localization;
  239.     }
  241.     /**
  242.      * Returns the localization code, which is a combination of the language and the country in a specific format.
  243.      *
  244.      * @param string $format requested localization format
  245.      *
  246.      * @return string
  247.      *
  248.      * @VirtualProperty
  249.      * @Groups({"frontend", "Default"})
  250.      */
  251.     public function getLocale($format = self::UNDERSCORE)
  252.     {
  253.         $localization = \strtolower($this->getLanguage());
  255.         if (null != $this->getCountry()) {
  256.             $country = \strtolower($this->getCountry());
  257.             $delimiter = '-';
  259.             switch ($format) {
  260.                 case self::UNDERSCORE:
  261.                     $delimiter = '_';
  262.                     break;
  263.                 case self::ISO6391:
  264.                     $country = \strtoupper($country);
  265.                     break;
  266.                 case self::LCID:
  267.                     $delimiter = '_';
  268.                     $country = \strtoupper($country);
  269.                     break;
  270.             }
  272.             $localization .= $delimiter . $country;
  273.         }
  275.         return $localization;
  276.     }
  278.     /**
  279.      * Sets the parent of this localization.
  280.      */
  281.     public function setParent(self $parent)
  282.     {
  283.         $this->parent = $parent;
  284.     }
  286.     /**
  287.      * Returns the parent of this localization.
  288.      *
  289.      * @return Localization
  290.      */
  291.     public function getParent()
  292.     {
  293.         return $this->parent;
  294.     }
  296.     /**
  297.      * Sets if this localization is the default one.
  298.      *
  299.      * @param bool $default
  300.      */
  301.     public function setDefault($default)
  302.     {
  303.         $this->default = $default;
  304.     }
  306.     /**
  307.      * Sets if this localization is the x-default one.
  308.      *
  309.      * @param bool $xDefault
  310.      *
  311.      * @deprecated use setDefault to set the default Localization
  312.      */
  313.     public function setXDefault($xDefault)
  314.     {
  315.         @trigger_deprecation('sulu/sulu', '2.3', 'The "%s" method is deprecated on "%s" use "setDefault" instead.', __METHOD__, __CLASS__);
  317.         $this->xDefault = $xDefault;
  318.     }
  320.     /**
  321.      * Returns if this localization is the default one.
  322.      *
  323.      * @return bool True if this is the default localization, otherwise false
  324.      */
  325.     public function isDefault()
  326.     {
  327.         return $this->default;
  328.     }
  330.     /**
  331.      * Returns if this localization is the x-default one.
  332.      *
  333.      * @return bool True if this is the x-default localization, otherwise false
  334.      *
  335.      * @deprecated use getDefault to get the default Localization
  336.      */
  337.     public function isXDefault()
  338.     {
  339.         if (\func_num_args() < 1 || \func_get_arg(0)) {
  340.             @trigger_deprecation('sulu/sulu', '2.4', 'The "%s" method is deprecated on "%s" use "isDefault" instead.', __METHOD__, __CLASS__);
  341.         }
  343.         return $this->xDefault;
  344.     }
  346.     /**
  347.      * @param string $localization
  348.      *
  349.      * @return Localization|null
  350.      */
  351.     public function findLocalization($localization)
  352.     {
  353.         if ($this->getLocale() == $localization) {
  354.             return $this;
  355.         }
  357.         $children = $this->getChildren();
  358.         if (!empty($children)) {
  359.             foreach ($children as $childLocalization) {
  360.                 $result = $childLocalization->findLocalization($localization);
  361.                 if ($result) {
  362.                     return $result;
  363.                 }
  364.             }
  365.         }
  367.         return;
  368.     }
  370.     /**
  371.      * Returns a list of all localizations and sublocalizations.
  372.      *
  373.      * @return Localization[]
  374.      */
  375.     public function getAllLocalizations()
  376.     {
  377.         $localizations = [];
  378.         if (null !== $this->getChildren() && \count($this->getChildren()) > 0) {
  379.             foreach ($this->getChildren() as $child) {
  380.                 $localizations[] = $child;
  381.                 $localizations = \array_merge($localizations, $child->getAllLocalizations());
  382.             }
  383.         }
  385.         return $localizations;
  386.     }
  388.     /**
  389.      * @return string
  390.      */
  391.     public function __toString()
  392.     {
  393.         return $this->getLocale();
  394.     }
  396.     #[\ReturnTypeWillChange]
  397.     public function jsonSerialize()
  398.     {
  399.         return [
  400.             'localization' => $this->getLocale(),
  401.             'name' => $this->getLocale(),
  402.         ];
  403.     }
  405.     public function toArray($depth = null)
  406.     {
  407.         $res = [];
  408.         $res['country'] = $this->getCountry();
  409.         $res['language'] = $this->getLanguage();
  410.         $res['localization'] = $this->getLocale();
  411.         $res['default'] = $this->isDefault();
  412.         $res['xDefault'] = $this->isXDefault(false);
  413.         $res['children'] = [];
  415.         $children = $this->getChildren();
  416.         if ($children) {
  417.             foreach ($this->getChildren() as $childLocalization) {
  418.                 $res['children'][] = $childLocalization->toArray(null);
  419.             }
  420.         }
  422.         $res['shadow'] = $this->getShadow();
  424.         return $res;
  425.     }
  426. }