vendor/sulu/sulu/src/Sulu/Component/Webspace/Loader/XmlFileLoader11.php line 29

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\Webspace\Loader;
  14. use Sulu\Component\Webspace\Loader\Exception\ExpectedDefaultTemplatesNotFound;
  15. use Sulu\Component\Webspace\Webspace;
  17. /**
  18.  * This file loader is responsible for loading webspace configuration files using the xml format with the webspace
  19.  * schema version 1.1.
  20.  */
  21. class XmlFileLoader11 extends XmlFileLoader10
  22. {
  23.     public const SCHEMA_LOCATION = '/schema/webspace/webspace-1.1.xsd';
  25.     public const SCHEMA_URI = 'http://schemas.sulu.io/webspace/webspace-1.1.xsd';
  27.     protected function parseXml($file)
  28.     {
  29.         $webspace = parent::parseXml($file);
  31.         $strategyNode = $this->xpath->query('/x:webspace/x:resource-locator/x:strategy')->item(0);
  32.         if (null !== $strategyNode) {
  33.             $webspace->setResourceLocatorStrategy($strategyNode->nodeValue);
  34.         } else {
  35.             $webspace->setResourceLocatorStrategy('tree_leaf_edit');
  36.         }
  38.         $this->generateExcludedTemplates($webspace);
  40.         return $webspace;
  41.     }
  43.     protected function generateDefaultTemplates(Webspace $webspace)
  44.     {
  45.         $expected = ['page', 'home'];
  47.         foreach ($this->xpath->query('/x:webspace/x:default-templates/x:default-template') as $node) {
  48.             /* @var \DOMNode $node */
  49.             $template = $node->nodeValue;
  50.             $type = $node->attributes->getNamedItem('type')->nodeValue;
  52.             $webspace->addDefaultTemplate($type, $template);
  53.             if ('homepage' === $type) {
  54.                 $webspace->addDefaultTemplate('home', $template);
  55.             }
  56.         }
  58.         $found = \array_keys($webspace->getDefaultTemplates());
  59.         foreach ($expected as $item) {
  60.             if (!\in_array($item, $found)) {
  61.                 throw new ExpectedDefaultTemplatesNotFound($this->webspace->getKey(), $expected, $found);
  62.             }
  63.         }
  65.         return $webspace;
  66.     }
  68.     /**
  69.      * Adds the template for the given types as described in the XML document.
  70.      *
  71.      * The types can be arbitrary, so that another bundle can easily add a new type and use the information from the
  72.      * webspace.
  73.      *
  74.      * @return Webspace
  75.      */
  76.     protected function generateTemplates(Webspace $webspace)
  77.     {
  78.         foreach ($this->xpath->query('/x:webspace/x:templates/x:template') as $templateNode) {
  79.             /* @var \DOMNode $templateNode */
  80.             $template = $templateNode->nodeValue;
  81.             $type = $templateNode->attributes->getNamedItem('type')->nodeValue;
  82.             $webspace->addTemplate($type, $template);
  83.         }
  85.         return $webspace;
  86.     }
  88.     /**
  89.      * Adds the excluded-templates as described in the XML document.
  90.      *
  91.      * @return Webspace
  92.      */
  93.     protected function generateExcludedTemplates(Webspace $webspace)
  94.     {
  95.         foreach ($this->xpath->query('/x:webspace/x:excluded-templates/x:excluded-template') as $excludedTemplateNode) {
  96.             /* @var \DOMNode $excludedTemplateNode */
  97.             $excludedTemplate = $excludedTemplateNode->nodeValue;
  98.             $webspace->addExcludedTemplate($excludedTemplate);
  99.         }
  101.         return $webspace;
  102.     }
  103. }