vendor/sulu/sulu/src/Sulu/Component/Webspace/Portal.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\Webspace;
  14. use Sulu\Component\Localization\Localization;
  15. use Sulu\Component\Webspace\Exception\EnvironmentNotFoundException;
  16. use Sulu\Component\Webspace\Exception\PortalLocalizationNotFoundException;
  18. /**
  19.  * Container for a portal configuration.
  20.  */
  21. class Portal
  22. {
  23.     /**
  24.      * The name of the portal.
  25.      *
  26.      * @var string
  27.      */
  28.     private $name;
  30.     /**
  31.      * The key of the portal.
  32.      *
  33.      * @var string
  34.      */
  35.     private $key;
  37.     /**
  38.      * An array of localizations.
  39.      *
  40.      * @var Localization[]
  41.      */
  42.     private $localizations;
  44.     /**
  45.      * The default localization for this portal.
  46.      *
  47.      * @var Localization
  48.      */
  49.     private $defaultLocalization;
  51.     /**
  52.      * The x-default localization for this portal.
  53.      *
  54.      * @deprecated use $defaultLocalization instead
  55.      *
  56.      * @var Localization
  57.      */
  58.     private $xDefaultLocalization;
  60.     /**
  61.      * @var Environment[]
  62.      */
  63.     private $environments;
  65.     /**
  66.      * @var Webspace
  67.      */
  68.     private $webspace;
  70.     /**
  71.      * Sets the name of the portal.
  72.      *
  73.      * @param string $name The name of the portal
  74.      */
  75.     public function setName($name)
  76.     {
  77.         $this->name = $name;
  78.     }
  80.     /**
  81.      * Returns the name of the portal.
  82.      *
  83.      * @return string The name of the portal
  84.      */
  85.     public function getName()
  86.     {
  87.         return $this->name;
  88.     }
  90.     /**
  91.      * @param string $key
  92.      */
  93.     public function setKey($key)
  94.     {
  95.         $this->key = $key;
  96.     }
  98.     /**
  99.      * @return string
  100.      */
  101.     public function getKey()
  102.     {
  103.         return $this->key;
  104.     }
  106.     /**
  107.      * Adds the given language to the portal.
  108.      */
  109.     public function addLocalization(Localization $localization)
  110.     {
  111.         $this->localizations[] = $localization;
  113.         if ($localization->isDefault()) {
  114.             $this->setDefaultLocalization($localization);
  115.         }
  117.         if ($localization->isXDefault(false)) {
  118.             $this->setXDefaultLocalization($localization, false);
  119.         }
  120.     }
  122.     /**
  123.      * Sets the localizations to this portal.
  124.      *
  125.      * @param Localization[] $localizations
  126.      */
  127.     public function setLocalizations($localizations)
  128.     {
  129.         $this->localizations = $localizations;
  130.     }
  132.     /**
  133.      * Returns the languages of this portal.
  134.      *
  135.      * @return Localization[] The languages of this portal
  136.      */
  137.     public function getLocalizations()
  138.     {
  139.         return $this->localizations;
  140.     }
  142.     public function getLocalization($locale)
  143.     {
  144.         foreach ($this->getLocalizations() as $localization) {
  145.             if ($locale === $localization->getLocale()) {
  146.                 return $localization;
  147.             }
  148.         }
  150.         throw new PortalLocalizationNotFoundException($this, $locale);
  151.     }
  153.     /**
  154.      * @param Localization $defaultLocalization
  155.      */
  156.     public function setDefaultLocalization($defaultLocalization)
  157.     {
  158.         $this->defaultLocalization = $defaultLocalization;
  160.         if (!$this->getXDefaultLocalization()) {
  161.             $this->setXDefaultLocalization($defaultLocalization);
  162.         }
  163.     }
  165.     /**
  166.      * @return Localization
  167.      */
  168.     public function getDefaultLocalization()
  169.     {
  170.         return $this->defaultLocalization;
  171.     }
  173.     /**
  174.      * @param Localization $xDefaultLocalization
  175.      *
  176.      * @deprecated use setDefaultLocalization instead
  177.      */
  178.     public function setXDefaultLocalization($xDefaultLocalization)
  179.     {
  180.         if (\func_num_args() < 2 || \func_get_arg(1)) {
  181.             @trigger_deprecation('sulu/sulu', '2.3', 'The "%s" method is deprecated on "%s" use "setDefaultLocalization" instead.', __METHOD__, __CLASS__);
  182.         }
  184.         $this->xDefaultLocalization = $xDefaultLocalization;
  185.     }
  187.     /**
  188.      * @return Localization
  189.      *
  190.      * @deprecated use getDefaultLocalization instead
  191.      */
  192.     public function getXDefaultLocalization()
  193.     {
  194.         @trigger_deprecation('sulu/sulu', '2.3', 'The "%s" method is deprecated on "%s" use "getDefaultLocalization" instead.', __METHOD__, __CLASS__);
  196.         return $this->xDefaultLocalization;
  197.     }
  199.     /**
  200.      * Adds an environment to this portal.
  201.      *
  202.      * @param Environment $environment Environment The environment to add
  203.      */
  204.     public function addEnvironment($environment)
  205.     {
  206.         $this->environments[$environment->getType()] = $environment;
  207.     }
  209.     /**
  210.      * Sets the environments for this portal.
  211.      *
  212.      * @param Environment[] $environments
  213.      */
  214.     public function setEnvironments(array $environments)
  215.     {
  216.         $this->environments = [];
  218.         foreach ($environments as $environment) {
  219.             $this->addEnvironment($environment);
  220.         }
  221.     }
  223.     /**
  224.      * Returns the environment for this portal.
  225.      *
  226.      * @return Environment[]
  227.      */
  228.     public function getEnvironments()
  229.     {
  230.         return $this->environments;
  231.     }
  233.     /**
  234.      * Returns the environment with the given type, and throws an exception if the environment does not exist.
  235.      *
  236.      * @param string $type
  237.      *
  238.      * @return Environment
  239.      *
  240.      * @throws Exception\EnvironmentNotFoundException
  241.      */
  242.     public function getEnvironment($type)
  243.     {
  244.         if (!isset($this->environments[$type])) {
  245.             throw new EnvironmentNotFoundException($this, $type);
  246.         }
  248.         return $this->environments[$type];
  249.     }
  251.     public function setWebspace(Webspace $webspace)
  252.     {
  253.         $this->webspace = $webspace;
  254.     }
  256.     /**
  257.      * @return Webspace
  258.      */
  259.     public function getWebspace()
  260.     {
  261.         return $this->webspace;
  262.     }
  264.     public function toArray($depth = null)
  265.     {
  266.         $res = [];
  267.         $res['name'] = $this->getName();
  268.         $res['key'] = $this->getKey();
  270.         $res['localizations'] = [];
  272.         foreach ($this->getLocalizations() as $localization) {
  273.             $res['localizations'][] = $localization->toArray();
  274.         }
  276.         foreach ($this->getEnvironments() as $environment) {
  277.             $res['environments'][] = $environment->toArray();
  278.         }
  280.         return $res;
  281.     }
  282. }