vendor/pimcore/pimcore/models/Document/Page.php line 27

Open in your IDE?
  1. <?php
  2. /**
  3.  * Pimcore
  4.  *
  5.  * This source file is available under two different licenses:
  6.  * - GNU General Public License version 3 (GPLv3)
  7.  * - Pimcore Enterprise License (PEL)
  8.  * Full copyright and license information is available in
  9.  * LICENSE.md which is distributed with this source code.
  10.  *
  11.  * @category   Pimcore
  12.  * @package    Document
  13.  *
  14.  * @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  15.  * @license    http://www.pimcore.org/license     GPLv3 and PEL
  16.  */
  17. namespace Pimcore\Model\Document;
  18. use Pimcore\Model\Redirect;
  19. use Pimcore\Model\Site;
  20. use Pimcore\Model\Tool\Targeting\TargetGroup;
  21. /**
  22.  * @method \Pimcore\Model\Document\Page\Dao getDao()
  23.  */
  24. class Page extends TargetingDocument
  25. {
  26.     /**
  27.      * Contains the title of the page (meta-title)
  28.      *
  29.      * @var string
  30.      */
  31.     protected $title '';
  32.     /**
  33.      * Contains the description of the page (meta-description)
  34.      *
  35.      * @var string
  36.      */
  37.     protected $description '';
  38.     /**
  39.      * @var array
  40.      */
  41.     protected $metaData = [];
  42.     /**
  43.      * Static type of the document
  44.      *
  45.      * @var string
  46.      */
  47.     protected $type 'page';
  48.     /**
  49.      * @var string|null
  50.      */
  51.     protected $prettyUrl;
  52.     /**
  53.      * Comma separated IDs of target groups
  54.      *
  55.      * @var string
  56.      */
  57.     protected $targetGroupIds '';
  58.     /**
  59.      * @inheritdoc
  60.      */
  61.     public function delete(bool $isNested false)
  62.     {
  63.         if ($this->getId() == 1) {
  64.             throw new \Exception('root-node cannot be deleted');
  65.         }
  66.         // check for redirects pointing to this document, and delete them too
  67.         $redirects = new Redirect\Listing();
  68.         $redirects->setCondition('target = ?'$this->getId());
  69.         $redirects->load();
  70.         foreach ($redirects->getRedirects() as $redirect) {
  71.             $redirect->delete();
  72.         }
  73.         if ($site Site::getByRootId($this->getId())) {
  74.             $site->delete();
  75.         }
  76.         parent::delete($isNested);
  77.     }
  78.     /**
  79.      * @return string
  80.      */
  81.     public function getDescription()
  82.     {
  83.         return $this->description;
  84.     }
  85.     /**
  86.      * @return string
  87.      */
  88.     public function getTitle()
  89.     {
  90.         return \Pimcore\Tool\Text::removeLineBreaks($this->title);
  91.     }
  92.     /**
  93.      * @param string $description
  94.      *
  95.      * @return $this
  96.      */
  97.     public function setDescription($description)
  98.     {
  99.         $this->description str_replace("\n"' '$description);
  100.         return $this;
  101.     }
  102.     /**
  103.      * @param string $title
  104.      *
  105.      * @return $this
  106.      */
  107.     public function setTitle($title)
  108.     {
  109.         $this->title $title;
  110.         return $this;
  111.     }
  112.     /**
  113.      * @param array $metaData
  114.      *
  115.      * @return $this
  116.      */
  117.     public function setMetaData($metaData)
  118.     {
  119.         $this->metaData $metaData;
  120.         return $this;
  121.     }
  122.     /**
  123.      * @return array
  124.      */
  125.     public function getMetaData()
  126.     {
  127.         return $this->metaData;
  128.     }
  129.     /**
  130.      * @inheritDoc
  131.      */
  132.     public function getFullPath(bool $force false)
  133.     {
  134.         $path parent::getFullPath($force);
  135.         // do not use pretty url's when in admin, the current document is wrapped by a hardlink or this document isn't in the current site
  136.         if (!\Pimcore::inAdmin() && !($this instanceof Hardlink\Wrapper\WrapperInterface) && \Pimcore\Tool\Frontend::isDocumentInCurrentSite($this)) {
  137.             // check for a pretty url
  138.             $prettyUrl $this->getPrettyUrl();
  139.             if (!empty($prettyUrl) && strlen($prettyUrl) > 1) {
  140.                 return $prettyUrl;
  141.             }
  142.         }
  143.         return $path;
  144.     }
  145.     /**
  146.      * @param string $prettyUrl
  147.      *
  148.      * @return $this
  149.      */
  150.     public function setPrettyUrl($prettyUrl)
  151.     {
  152.         $this->prettyUrl '/' trim($prettyUrl' /');
  153.         if (strlen($this->prettyUrl) < 2) {
  154.             $this->prettyUrl null;
  155.         }
  156.         return $this;
  157.     }
  158.     /**
  159.      * @return string|null
  160.      */
  161.     public function getPrettyUrl()
  162.     {
  163.         return $this->prettyUrl;
  164.     }
  165.     /**
  166.      * Set linked Target Groups as set in properties panel as list of IDs
  167.      *
  168.      * @param string|array $targetGroupIds
  169.      */
  170.     public function setTargetGroupIds($targetGroupIds)
  171.     {
  172.         if (is_array($targetGroupIds)) {
  173.             $targetGroupIds implode(','$targetGroupIds);
  174.         }
  175.         $targetGroupIds trim($targetGroupIds' ,');
  176.         if (!empty($targetGroupIds)) {
  177.             $targetGroupIds ',' $targetGroupIds ',';
  178.         }
  179.         $this->targetGroupIds $targetGroupIds;
  180.     }
  181.     /**
  182.      * Get serialized list of Target Group IDs
  183.      *
  184.      * @return string
  185.      */
  186.     public function getTargetGroupIds(): string
  187.     {
  188.         return $this->targetGroupIds;
  189.     }
  190.     /**
  191.      * Set assigned target groups
  192.      *
  193.      * @param TargetGroup[]|int[] $targetGroups
  194.      */
  195.     public function setTargetGroups(array $targetGroups)
  196.     {
  197.         $ids array_map(function ($targetGroup) {
  198.             if (is_numeric($targetGroup)) {
  199.                 return (int)$targetGroup;
  200.             } elseif ($targetGroup instanceof TargetGroup) {
  201.                 return $targetGroup->getId();
  202.             }
  203.             return null;
  204.         }, $targetGroups);
  205.         $ids array_filter($ids, function ($id) {
  206.             return null !== $id && $id 0;
  207.         });
  208.         $this->setTargetGroupIds($ids);
  209.     }
  210.     /**
  211.      * Return list of assigned target groups (via properties panel)
  212.      *
  213.      * @return TargetGroup[]
  214.      */
  215.     public function getTargetGroups(): array
  216.     {
  217.         $ids explode(','$this->targetGroupIds);
  218.         $targetGroups array_map(function ($id) {
  219.             $id trim($id);
  220.             if (!empty($id)) {
  221.                 $targetGroup TargetGroup::getById($id);
  222.                 if ($targetGroup) {
  223.                     return $targetGroup;
  224.                 }
  225.             }
  226.         }, $ids);
  227.         $targetGroups array_filter($targetGroups);
  228.         return $targetGroups;
  229.     }
  230.     /**
  231.      * @param bool $hdpi
  232.      *
  233.      * @return string
  234.      */
  235.     public function getPreviewImageFilesystemPath($hdpi false)
  236.     {
  237.         $suffix '';
  238.         if ($hdpi) {
  239.             $suffix '@2x';
  240.         }
  241.         return PIMCORE_SYSTEM_TEMP_DIRECTORY '/document-page-previews/document-page-screenshot-' $this->getId() . $suffix '.jpg';
  242.     }
  243. }