vendor/sulu/sulu/src/Sulu/Component/Webspace/Webspace.php line 20

  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\Util\ArrayableInterface;
  17. /**
  18.  * Container for a webspace definition.
  19.  */
  20. class Webspace implements ArrayableInterface
  21. {
  22.     /**
  23.      * The name of the webspace.
  24.      *
  25.      * @var string
  26.      */
  27.     private $name;
  29.     /**
  30.      * The key of the webspace.
  31.      *
  32.      * @var string
  33.      */
  34.     private $key;
  36.     /**
  37.      * The localizations defined for this webspace.
  38.      *
  39.      * @var Localization[]
  40.      */
  41.     private $localizations = [];
  43.     /**
  44.      * The default localization defined for this webspace.
  45.      *
  46.      * @var Localization
  47.      */
  48.     private $defaultLocalization;
  50.     /**
  51.      * The x-default localization defined for this webspace.
  52.      *
  53.      * @var Localization
  54.      */
  55.     private $xDefaultLocalization;
  57.     /**
  58.      * The segments defined for this webspace.
  59.      *
  60.      * @var Segment[]
  61.      */
  62.     private $segments = [];
  64.     /**
  65.      * The default segment defined for this webspace.
  66.      *
  67.      * @var Segment
  68.      */
  69.     private $defaultSegment;
  71.     /**
  72.      * The theme of the webspace.
  73.      *
  74.      * @var string
  75.      */
  76.     private $theme;
  78.     /**
  79.      * The portals defined for this webspace.
  80.      *
  81.      * @var Portal[]
  82.      */
  83.     private $portals = [];
  85.     /**
  86.      * The security system for this webspace.
  87.      *
  88.      * @var Security|null
  89.      */
  90.     private $security;
  92.     /**
  93.      * Navigation for this webspace.
  94.      *
  95.      * @var Navigation
  96.      */
  97.     private $navigation;
  99.     /**
  100.      * A list of twig templates.
  101.      *
  102.      * @var array
  103.      */
  104.     private $templates = [];
  106.     /**
  107.      * Template which is selected by default if no other template is chosen.
  108.      *
  109.      * @var string[]
  110.      */
  111.     private $defaultTemplates = [];
  113.     /**
  114.      * @var string[]
  115.      */
  116.     private $excludedTemplates = [];
  118.     /**
  119.      * The url generation strategy for this portal.
  120.      *
  121.      * @var string
  122.      */
  123.     private $resourceLocatorStrategy;
  125.     /**
  126.      * Sets the key of the webspace.
  127.      *
  128.      * @param string $key
  129.      */
  130.     public function setKey($key)
  131.     {
  132.         $this->key = $key;
  133.     }
  135.     /**
  136.      * Returns the key of the webspace.
  137.      *
  138.      * @return string
  139.      */
  140.     public function getKey()
  141.     {
  142.         return $this->key;
  143.     }
  145.     /**
  146.      * Adds a localization to the webspace.
  147.      */
  148.     public function addLocalization(Localization $localization)
  149.     {
  150.         $this->localizations[] = $localization;
  152.         if ($localization->isDefault()) {
  153.             $this->setDefaultLocalization($localization);
  154.         }
  156.         if ($localization->isXDefault(false)) {
  157.             $this->xDefaultLocalization = $localization;
  158.         }
  159.     }
  161.     /**
  162.      * Returns the localizations of this webspace.
  163.      *
  164.      * @param Localization[] $localizations
  165.      */
  166.     public function setLocalizations($localizations)
  167.     {
  168.         $this->localizations = $localizations;
  169.     }
  171.     /**
  172.      * Returns the localizations of this webspace.
  173.      *
  174.      * @return Localization[]
  175.      */
  176.     public function getLocalizations()
  177.     {
  178.         return $this->localizations;
  179.     }
  181.     /**
  182.      * Returns a list of all localizations and sublocalizations.
  183.      *
  184.      * @return Localization[]
  185.      */
  186.     public function getAllLocalizations()
  187.     {
  188.         $localizations = [];
  189.         foreach ($this->getLocalizations() as $child) {
  190.             $localizations[] = $child;
  191.             $localizations = \array_merge($localizations, $child->getAllLocalizations());
  192.         }
  194.         return $localizations;
  195.     }
  197.     /**
  198.      * Returns the localization object for a given localization string.
  199.      *
  200.      * @param string $localization
  201.      *
  202.      * @return Localization|null
  203.      */
  204.     public function getLocalization($localization)
  205.     {
  206.         $localizations = $this->getLocalizations();
  207.         if (!empty($localizations)) {
  208.             foreach ($localizations as $webspaceLocalization) {
  209.                 $result = $webspaceLocalization->findLocalization($localization);
  211.                 if ($result) {
  212.                     return $result;
  213.                 }
  214.             }
  215.         }
  217.         return;
  218.     }
  220.     /**
  221.      * Sets the default localization for this webspace.
  222.      *
  223.      * @param Localization $defaultLocalization
  224.      */
  225.     public function setDefaultLocalization($defaultLocalization)
  226.     {
  227.         $this->defaultLocalization = $defaultLocalization;
  229.         if (!$this->getXDefaultLocalization()) {
  230.             $this->xDefaultLocalization = $defaultLocalization;
  231.         }
  232.     }
  234.     /**
  235.      * Returns the default localization for this webspace.
  236.      *
  237.      * @return Localization
  238.      */
  239.     public function getDefaultLocalization()
  240.     {
  241.         if (!$this->defaultLocalization) {
  242.             return $this->localizations[0];
  243.         }
  245.         return $this->defaultLocalization;
  246.     }
  248.     /**
  249.      * Returns the x-default localization for this webspace.
  250.      *
  251.      * @return Localization
  252.      */
  253.     public function getXDefaultLocalization()
  254.     {
  255.         if (!$this->xDefaultLocalization) {
  256.             return $this->localizations[0];
  257.         }
  259.         return $this->xDefaultLocalization;
  260.     }
  262.     /**
  263.      * Sets the name of the webspace.
  264.      *
  265.      * @param string $name
  266.      */
  267.     public function setName($name)
  268.     {
  269.         $this->name = $name;
  270.     }
  272.     /**
  273.      * Returns the name of the webspace.
  274.      *
  275.      * @return string
  276.      */
  277.     public function getName()
  278.     {
  279.         return $this->name;
  280.     }
  282.     /**
  283.      * Adds a portal to the webspace.
  284.      */
  285.     public function addPortal(Portal $portal)
  286.     {
  287.         $this->portals[] = $portal;
  288.     }
  290.     /**
  291.      * Sets the portals of this webspace.
  292.      *
  293.      * @param Portal[] $portals
  294.      */
  295.     public function setPortals($portals)
  296.     {
  297.         $this->portals = $portals;
  298.     }
  300.     /**
  301.      * Returns the portals of this webspace.
  302.      *
  303.      * @return Portal[]
  304.      */
  305.     public function getPortals()
  306.     {
  307.         return $this->portals;
  308.     }
  310.     /**
  311.      * Adds a segment to the webspace.
  312.      */
  313.     public function addSegment(Segment $segment)
  314.     {
  315.         $this->segments[] = $segment;
  317.         if ($segment->isDefault()) {
  318.             $this->setDefaultSegment($segment);
  319.         }
  320.     }
  322.     /**
  323.      * Sets the segments of this webspace.
  324.      *
  325.      * @param Segment[] $segments
  326.      */
  327.     public function setSegments($segments)
  328.     {
  329.         $this->segments = $segments;
  330.     }
  332.     /**
  333.      * Returns the segments of this webspace.
  334.      *
  335.      * @return Segment[]
  336.      */
  337.     public function getSegments()
  338.     {
  339.         return $this->segments;
  340.     }
  342.     public function getSegment(string $segmentKey): ?Segment
  343.     {
  344.         foreach ($this->segments as $segment) {
  345.             if ($segment->getKey() === $segmentKey) {
  346.                 return $segment;
  347.             }
  348.         }
  350.         return null;
  351.     }
  353.     /**
  354.      * Sets the default segment of this webspace.
  355.      *
  356.      * @param Segment $defaultSegment
  357.      */
  358.     public function setDefaultSegment($defaultSegment)
  359.     {
  360.         $this->defaultSegment = $defaultSegment;
  361.     }
  363.     /**
  364.      * Returns the default segment for this webspace.
  365.      *
  366.      * @return Segment
  367.      */
  368.     public function getDefaultSegment()
  369.     {
  370.         return $this->defaultSegment;
  371.     }
  373.     /**
  374.      * Sets the theme for this portal.
  375.      *
  376.      * @param string|null $theme this parameter is options
  377.      */
  378.     public function setTheme($theme = null)
  379.     {
  380.         $this->theme = $theme;
  381.     }
  383.     /**
  384.      * Returns the theme for this portal.
  385.      *
  386.      * @return string
  387.      */
  388.     public function getTheme()
  389.     {
  390.         return $this->theme;
  391.     }
  393.     /**
  394.      * Sets the security system.
  395.      *
  396.      * @param Security|null $security
  397.      */
  398.     public function setSecurity($security)
  399.     {
  400.         $this->security = $security;
  401.     }
  403.     /**
  404.      * Returns the security system.
  405.      *
  406.      * @return Security|null
  407.      */
  408.     public function getSecurity()
  409.     {
  410.         return $this->security;
  411.     }
  413.     public function hasWebsiteSecurity()
  414.     {
  415.         $security = $this->getSecurity();
  417.         if (!$security) {
  418.             return false;
  419.         }
  421.         return null !== $security->getSystem() && $security->getPermissionCheck();
  422.     }
  424.     /**
  425.      * @return Navigation
  426.      */
  427.     public function getNavigation()
  428.     {
  429.         return $this->navigation;
  430.     }
  432.     /**
  433.      * @param Navigation $navigation
  434.      */
  435.     public function setNavigation($navigation)
  436.     {
  437.         $this->navigation = $navigation;
  438.     }
  440.     /**
  441.      * Returns false if domain not exists in webspace.
  442.      *
  443.      * @param string $domain
  444.      * @param string $environment
  445.      * @param string $locale
  446.      *
  447.      * @return bool
  448.      *
  449.      * @throws Exception\EnvironmentNotFoundException
  450.      */
  451.     public function hasDomain($domain, $environment, $locale = null)
  452.     {
  453.         $localizationParts = \explode('_', $locale);
  454.         $language = $localizationParts[0];
  455.         $country = isset($localizationParts[1]) ? $localizationParts[1] : '';
  457.         foreach ($this->getPortals() as $portal) {
  458.             foreach ($portal->getEnvironment($environment)->getUrls() as $url) {
  459.                 $host = \parse_url('//' . $url->getUrl())['host'];
  460.                 if ((null === $locale || $url->isValidLocale($language, $country))
  461.                     && ($host === $domain || '{host}' === $host)
  462.                 ) {
  463.                     return true;
  464.                 }
  465.             }
  466.         }
  468.         return false;
  469.     }
  471.     /**
  472.      * Add a new template for given type.
  473.      *
  474.      * @param string $type
  475.      * @param string $template
  476.      */
  477.     public function addTemplate($type, $template)
  478.     {
  479.         $this->templates[$type] = $template;
  480.     }
  482.     /**
  483.      * Returns a template for the given type.
  484.      *
  485.      * @param string $type
  486.      * @param string $format
  487.      *
  488.      * @return string|null
  489.      */
  490.     public function getTemplate($type, $format = 'html')
  491.     {
  492.         if (\array_key_exists($type, $this->templates)) {
  493.             return $this->templates[$type] . '.' . $format . '.twig';
  494.         }
  496.         return;
  497.     }
  499.     /**
  500.      * Returns an array of templates.
  501.      *
  502.      * @return string[]
  503.      */
  504.     public function getTemplates()
  505.     {
  506.         return $this->templates;
  507.     }
  509.     /**
  510.      * Add a new default template for given type.
  511.      *
  512.      * @param string $type
  513.      * @param string $template
  514.      */
  515.     public function addDefaultTemplate($type, $template)
  516.     {
  517.         $this->defaultTemplates[$type] = $template;
  518.     }
  520.     /**
  521.      * Returns a error template for given code.
  522.      *
  523.      * @param string $type
  524.      *
  525.      * @return string|null
  526.      */
  527.     public function getDefaultTemplate($type)
  528.     {
  529.         if (\array_key_exists($type, $this->defaultTemplates)) {
  530.             return $this->defaultTemplates[$type];
  531.         }
  533.         return;
  534.     }
  536.     /**
  537.      * Returns a array of default template.
  538.      *
  539.      * @return string[]
  540.      */
  541.     public function getDefaultTemplates()
  542.     {
  543.         return $this->defaultTemplates;
  544.     }
  546.     /**
  547.      * Add a new template for given type.
  548.      *
  549.      * @param string $excludedTemplate
  550.      */
  551.     public function addExcludedTemplate($excludedTemplate)
  552.     {
  553.         $this->excludedTemplates[] = $excludedTemplate;
  554.     }
  556.     /**
  557.      * @return string[]
  558.      */
  559.     public function getExcludedTemplates()
  560.     {
  561.         return $this->excludedTemplates;
  562.     }
  564.     /**
  565.      * Set resource-locator strategy.
  566.      *
  567.      * @param string $resourceLocatorStrategy
  568.      */
  569.     public function setResourceLocatorStrategy($resourceLocatorStrategy)
  570.     {
  571.         $this->resourceLocatorStrategy = $resourceLocatorStrategy;
  572.     }
  574.     /**
  575.      * Returns resource-locator strategy.
  576.      *
  577.      * @return string
  578.      */
  579.     public function getResourceLocatorStrategy()
  580.     {
  581.         return $this->resourceLocatorStrategy;
  582.     }
  584.     public function toArray($depth = null)
  585.     {
  586.         $res = [];
  587.         $res['key'] = $this->getKey();
  588.         $res['name'] = $this->getName();
  589.         $res['localizations'] = [];
  590.         $res['templates'] = $this->getTemplates();
  591.         $res['defaultTemplates'] = $this->getDefaultTemplates();
  592.         $res['excludedTemplates'] = $this->getExcludedTemplates();
  593.         $res['resourceLocator']['strategy'] = $this->getResourceLocatorStrategy();
  595.         foreach ($this->getLocalizations() as $localization) {
  596.             $res['localizations'][] = $localization->toArray();
  597.         }
  599.         $thisSecurity = $this->getSecurity();
  600.         if (null != $thisSecurity) {
  601.             $res['security']['system'] = $thisSecurity->getSystem();
  602.             $res['security']['permissionCheck'] = $thisSecurity->getPermissionCheck();
  603.         }
  605.         $res['segments'] = [];
  606.         $segments = $this->getSegments();
  608.         if (!empty($segments)) {
  609.             foreach ($segments as $segment) {
  610.                 $res['segments'][] = $segment->toArray();
  611.             }
  612.         }
  614.         $res['theme'] = !$this->theme ? null : $this->theme;
  616.         $res['portals'] = [];
  617.         foreach ($this->getPortals() as $portal) {
  618.             $res['portals'][] = $portal->toArray();
  619.         }
  621.         $res['navigation'] = [];
  622.         $res['navigation']['contexts'] = [];
  623.         if ($navigation = $this->getNavigation()) {
  624.             foreach ($navigation->getContexts() as $context) {
  625.                 $res['navigation']['contexts'][] = [
  626.                     'key' => $context->getKey(),
  627.                     'metadata' => $context->getMetadata(),
  628.                 ];
  629.             }
  630.         }
  632.         return $res;
  633.     }
  634. }