vendor/pimcore/pimcore/models/Document/TargetingDocument.php line 121

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /**
  6.  * Pimcore
  7.  *
  8.  * This source file is available under two different licenses:
  9.  * - GNU General Public License version 3 (GPLv3)
  10.  * - Pimcore Commercial License (PCL)
  11.  * Full copyright and license information is available in
  12.  * LICENSE.md which is distributed with this source code.
  13.  *
  14.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  15.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  16.  */
  18. namespace Pimcore\Model\Document;
  20. use Pimcore\Model\Document\Targeting\TargetingDocumentInterface;
  22. /**
  23.  * @method \Pimcore\Model\Document\Targeting\TargetingDocumentDaoInterface getDao()
  24.  */
  25. abstract class TargetingDocument extends PageSnippet implements TargetingDocumentInterface
  26. {
  27.     /**
  28.      * @internal
  29.      *
  30.      * @var int
  31.      */
  32.     private $useTargetGroup;
  34.     /**
  35.      * {@inheritdoc}
  36.      */
  37.     public function setUseTargetGroup(int $useTargetGroup = null)
  38.     {
  39.         $this->useTargetGroup = $useTargetGroup;
  40.     }
  42.     /**
  43.      * {@inheritdoc}
  44.      */
  45.     public function getUseTargetGroup()
  46.     {
  47.         return $this->useTargetGroup;
  48.     }
  50.     /**
  51.      * {@inheritdoc}
  52.      */
  53.     public function getTargetGroupEditablePrefix(int $targetGroupId = null): string
  54.     {
  55.         $prefix = '';
  57.         if (!$targetGroupId) {
  58.             $targetGroupId = $this->getUseTargetGroup();
  59.         }
  61.         if ($targetGroupId) {
  62.             $prefix = self::TARGET_GROUP_EDITABLE_PREFIX . $targetGroupId . self::TARGET_GROUP_EDITABLE_SUFFIX;
  63.         }
  65.         return $prefix;
  66.     }
  68.     /**
  69.      * {@inheritdoc}
  70.      */
  71.     public function getTargetGroupEditableName(string $name): string
  72.     {
  73.         if (!$this->getUseTargetGroup()) {
  74.             return $name;
  75.         }
  77.         $prefix = $this->getTargetGroupEditablePrefix();
  78.         if (!preg_match('/^' . preg_quote($prefix, '/') . '/', $name)) {
  79.             $name = $prefix . $name;
  80.         }
  82.         return $name;
  83.     }
  85.     /**
  86.      * {@inheritdoc}
  87.      */
  88.     public function hasTargetGroupSpecificEditables(): bool
  89.     {
  90.         return $this->getDao()->hasTargetGroupSpecificEditables();
  91.     }
  93.     /**
  94.      * {@inheritdoc}
  95.      */
  96.     public function getTargetGroupSpecificEditableNames(): array
  97.     {
  98.         return $this->getDao()->getTargetGroupSpecificEditableNames();
  99.     }
  101.     /**
  102.      * {@inheritdoc}
  103.      */
  104.     public function setEditable(Editable $editable)
  105.     {
  106.         if ($this->getUseTargetGroup()) {
  107.             $name = $this->getTargetGroupEditableName($editable->getName());
  108.             $editable->setName($name);
  109.         }
  111.         return parent::setEditable($editable);
  112.     }
  114.     /**
  115.      * Get an editable with the given key/name
  116.      *
  117.      * @param string $name
  118.      *
  119.      * @return Editable|null
  120.      */
  121.     public function getEditable($name)
  122.     {
  123.         // check if a target group is requested for this page, if yes deliver a different version of the editable (prefixed)
  124.         if ($this->getUseTargetGroup()) {
  125.             $targetGroupEditableName = $this->getTargetGroupEditableName($name);
  127.             if ($editable = parent::getEditable($targetGroupEditableName)) {
  128.                 return $editable;
  129.             } else {
  130.                 // if there's no dedicated content for this target group, inherit from the "original" content (unprefixed)
  131.                 // and mark it as inherited so it is clear in the ui that the content is not specific to the selected target group
  132.                 // replace all occurrences of the target group prefix, this is needed because of block-prefixes
  133.                 $inheritedName = str_replace($this->getTargetGroupEditablePrefix(), '', $name);
  134.                 $inheritedEditable = parent::getEditable($inheritedName);
  136.                 if ($inheritedEditable) {
  137.                     $inheritedEditable = clone $inheritedEditable;
  138.                     $inheritedEditable->setDao(null);
  139.                     $inheritedEditable->setName($targetGroupEditableName);
  140.                     $inheritedEditable->setInherited(true);
  142.                     $this->setEditable($inheritedEditable);
  144.                     return $inheritedEditable;
  145.                 }
  146.             }
  147.         }
  149.         // delegate to default
  150.         return parent::getEditable($name);
  151.     }
  153.     /**
  154.      * {@inheritdoc}
  155.      */
  156.     public function __sleep()
  157.     {
  158.         $finalVars = [];
  159.         $parentVars = parent::__sleep();
  161.         $blockedVars = ['useTargetGroup'];
  163.         foreach ($parentVars as $key) {
  164.             if (!in_array($key, $blockedVars)) {
  165.                 $finalVars[] = $key;
  166.             }
  167.         }
  169.         return $finalVars;
  170.     }
  171. }