vendor/sulu/sulu/src/Sulu/Component/Content/Query/ContentQueryBuilder.php line 92

  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\Content\Query;
  14. use Sulu\Component\Content\Compat\PropertyInterface;
  15. use Sulu\Component\Content\Compat\Structure;
  16. use Sulu\Component\Content\Compat\StructureInterface;
  17. use Sulu\Component\Content\Compat\StructureManagerInterface;
  18. use Sulu\Component\Content\Extension\ExtensionManagerInterface;
  19. use Sulu\Component\Content\Mapper\Translation\MultipleTranslatedProperties;
  20. use Sulu\Component\Content\Mapper\Translation\TranslatedProperty;
  22. /**
  23.  * Basic class for content query builder.
  24.  */
  25. abstract class ContentQueryBuilder implements ContentQueryBuilderInterface
  26. {
  27.     /**
  28.      * @var StructureManagerInterface
  29.      */
  30.     protected $structureManager;
  32.     /**
  33.      * @var ExtensionManagerInterface
  34.      */
  35.     protected $extensionManager;
  37.     /**
  38.      * @var string
  39.      */
  40.     protected $languageNamespace;
  42.     /**
  43.      * @var MultipleTranslatedProperties
  44.      */
  45.     private $translatedProperties;
  47.     /**
  48.      * @var string[]
  49.      */
  50.     private $defaultProperties = [
  51.         'template',
  52.         'changed',
  53.         'changer',
  54.         'creator',
  55.         'created',
  56.         'nodeType',
  57.         'state',
  58.         'shadow-on',
  59.     ];
  61.     /**
  62.      * @var string[]
  63.      */
  64.     protected $properties = [];
  66.     /**
  67.      * Only published content.
  68.      *
  69.      * @var bool
  70.      */
  71.     protected $published = true;
  73.     /**
  74.      * Load Excerpt data.
  75.      *
  76.      * @var bool
  77.      */
  78.     protected $excerpt = true;
  80.     protected static $mixinTypes = ['sulu:page', 'sulu:home'];
  82.     public function __construct(
  83.         StructureManagerInterface $structureManager,
  84.         ExtensionManagerInterface $extensionManager,
  85.         $languageNamespace
  86.     ) {
  87.         $this->structureManager = $structureManager;
  88.         $this->extensionManager = $extensionManager;
  89.         $this->languageNamespace = $languageNamespace;
  91.         $properties = \array_unique(\array_merge($this->defaultProperties, $this->properties));
  92.         $this->translatedProperties = new MultipleTranslatedProperties($properties, $this->languageNamespace);
  93.     }
  95.     /**
  96.      * Returns translated property name.
  97.      */
  98.     protected function getPropertyName($property)
  99.     {
  100.         return $this->translatedProperties->getName($property);
  101.     }
  103.     /**
  104.      * Configures translated properties to given locale.
  105.      *
  106.      * @param string $locale
  107.      */
  108.     protected function setLocale($locale)
  109.     {
  110.         $this->translatedProperties->setLanguage($locale);
  111.     }
  113.     public function build($webspaceKey, $locales)
  114.     {
  115.         $additionalFields = [];
  117.         $where = '';
  118.         $select = ['page.*'];
  119.         $order = [];
  121.         foreach ($locales as $locale) {
  122.             $this->setLocale($locale);
  123.             $additionalFields[$locale] = [];
  125.             if ($this->excerpt) {
  126.                 $this->buildSelectorForExcerpt($locale, $additionalFields);
  127.             }
  129.             $customSelect = $this->buildSelect($webspaceKey, $locale, $additionalFields);
  130.             if ('' !== $customSelect) {
  131.                 $select[] = $customSelect;
  132.             }
  134.             if ($this->published) {
  135.                 $where .= \sprintf(
  136.                     '%s ((page.[%s] = %s OR page.[%s] = %s)',
  137.                     '' !== $where ? 'OR ' : '',
  138.                     $this->getPropertyName('state'),
  139.                     Structure::STATE_PUBLISHED,
  140.                     $this->getPropertyName('shadow-on'),
  141.                     'true'
  142.                 );
  143.             }
  145.             $customWhere = $this->buildWhere($webspaceKey, $locale);
  146.             if (null !== $customWhere && '' !== $customWhere) {
  147.                 $where = $where . ('' !== $where ? ' AND ' : '') . $customWhere;
  148.             }
  150.             if ($this->published) {
  151.                 $where .= ')';
  152.             }
  154.             $customOrder = $this->buildOrder($webspaceKey, $locale);
  155.             if (!empty($customOrder)) {
  156.                 $order[] = $customOrder;
  157.             } else {
  158.                 $order = ['[jcr:path] ASC'];
  159.             }
  160.         }
  162.         $mixinTypeWhere = \implode(' OR ', \array_map(function($mixinType) {
  163.             return 'page.[jcr:mixinTypes] = "' . $mixinType . '"';
  164.         }, static::$mixinTypes));
  166.         $sql2 = \sprintf(
  167.             'SELECT %s
  168.              FROM [nt:unstructured] AS page
  169.              WHERE (%s)
  170.                 AND (%s)
  171.                 %s %s',
  172.             \implode(', ', $select),
  173.             $mixinTypeWhere,
  174.             $where,
  175.             \count($order) > 0 ? 'ORDER BY' : '',
  176.             \implode(', ', $order)
  177.         );
  179.         return [$sql2, $additionalFields];
  180.     }
  182.     public function getPublished()
  183.     {
  184.         return $this->published;
  185.     }
  187.     /**
  188.      * Returns custom select statement.
  189.      */
  190.     abstract protected function buildWhere($webspaceKey, $locale);
  192.     /**
  193.      * Returns custom where statement.
  194.      */
  195.     abstract protected function buildSelect($webspaceKey, $locale, &$additionalFields);
  197.     /**
  198.      * Returns custom order statement.
  199.      */
  200.     protected function buildOrder($webspaceKey, $locale)
  201.     {
  202.         return '';
  203.     }
  205.     /**
  206.      * Returns select statement with all url and title properties.
  207.      */
  208.     private function buildSelectForStructures($locale, $structures, &$names)
  209.     {
  210.         $result = '';
  211.         // add node name and url to selector
  212.         /** @var StructureInterface $structure */
  213.         foreach ($structures as $structure) {
  214.             $result .= $this->buildSelectForStructure($locale, $structure, $names);
  215.         }
  217.         return $result;
  218.     }
  220.     /**
  221.      * Returns select of a single structure with title and url selector.
  222.      */
  223.     private function buildSelectForStructure($locale, StructureInterface $structure, &$names)
  224.     {
  225.         $nodeNameProperty = $structure->getProperty('title');
  226.         $result = '';
  228.         $name = $this->getTranslatedProperty($nodeNameProperty, $locale)->getName();
  229.         if (!\in_array($name, $names)) {
  230.             $names[] = $name;
  231.             $result .= ', ' . $this->buildSelector($name);
  232.         }
  234.         if ($structure->hasTag('sulu.rlp')) {
  235.             $urlProperty = $structure->getPropertyByTagName('sulu.rlp');
  236.             $name = $this->getTranslatedProperty($urlProperty, $locale)->getName();
  238.             if ('resource_locator' !== $urlProperty->getContentTypeName() && !\in_array($name, $names)) {
  239.                 $names[] = $name;
  240.                 $result .= ', ' . $this->buildSelector($name);
  241.             }
  242.         }
  244.         return $result;
  245.     }
  247.     /**
  248.      * Returns a select statement for excerpt data.
  249.      */
  250.     private function buildSelectorForExcerpt($locale, &$additionalFields)
  251.     {
  252.         $excerptStructure = $this->structureManager->getStructure('excerpt');
  253.         $extension = $this->extensionManager->getExtension('', 'excerpt');
  255.         foreach ($excerptStructure->getProperties(true) as $property) {
  256.             $additionalFields[$locale][] = [
  257.                 'extension' => $extension,
  258.                 'target' => 'excerpt',
  259.                 'property' => $property->getName(),
  260.                 'name' => $property->getName(),
  261.             ];
  262.         }
  263.     }
  265.     /**
  266.      * Returns single select statement.
  267.      */
  268.     protected function buildSelector($name)
  269.     {
  270.         return \sprintf('page.[%s]', $name);
  271.     }
  273.     /**
  274.      * Returns a translated property.
  275.      */
  276.     protected function getTranslatedProperty(PropertyInterface $property, $locale)
  277.     {
  278.         return new TranslatedProperty($property, $locale, $this->languageNamespace);
  279.     }
  280. }