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.     protected function doDelete()
  62.     {
  63.         // check for redirects pointing to this document, and delete them too
  64.         $redirects = new Redirect\Listing();
  65.         $redirects->setCondition('target = ?'$this->getId());
  66.         $redirects->load();
  67.         foreach ($redirects->getRedirects() as $redirect) {
  68.             $redirect->delete();
  69.         }
  70.         if ($site Site::getByRootId($this->getId())) {
  71.             $site->delete();
  72.         }
  73.         parent::doDelete();
  74.     }
  75.     /**
  76.      * @return string
  77.      */
  78.     public function getDescription()
  79.     {
  80.         return $this->description;
  81.     }
  82.     /**
  83.      * @return string
  84.      */
  85.     public function getTitle()
  86.     {
  87.         return \Pimcore\Tool\Text::removeLineBreaks($this->title);
  88.     }
  89.     /**
  90.      * @param string $description
  91.      *
  92.      * @return $this
  93.      */
  94.     public function setDescription($description)
  95.     {
  96.         $this->description str_replace("\n"' '$description);
  97.         return $this;
  98.     }
  99.     /**
  100.      * @param string $title
  101.      *
  102.      * @return $this
  103.      */
  104.     public function setTitle($title)
  105.     {
  106.         $this->title $title;
  107.         return $this;
  108.     }
  109.     /**
  110.      * @param array $metaData
  111.      *
  112.      * @return $this
  113.      */
  114.     public function setMetaData($metaData)
  115.     {
  116.         $this->metaData $metaData;
  117.         return $this;
  118.     }
  119.     /**
  120.      * @return array
  121.      */
  122.     public function getMetaData()
  123.     {
  124.         return $this->metaData;
  125.     }
  126.     /**
  127.      * @inheritDoc
  128.      */
  129.     public function getFullPath(bool $force false)
  130.     {
  131.         $path parent::getFullPath($force);
  132.         // 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
  133.         if (!\Pimcore::inAdmin() && !($this instanceof Hardlink\Wrapper\WrapperInterface) && \Pimcore\Tool\Frontend::isDocumentInCurrentSite($this)) {
  134.             // check for a pretty url
  135.             $prettyUrl $this->getPrettyUrl();
  136.             if (!empty($prettyUrl) && strlen($prettyUrl) > 1) {
  137.                 return $prettyUrl;
  138.             }
  139.         }
  140.         return $path;
  141.     }
  142.     /**
  143.      * @param string $prettyUrl
  144.      *
  145.      * @return $this
  146.      */
  147.     public function setPrettyUrl($prettyUrl)
  148.     {
  149.         $this->prettyUrl '/' trim($prettyUrl' /');
  150.         if (strlen($this->prettyUrl) < 2) {
  151.             $this->prettyUrl null;
  152.         }
  153.         return $this;
  154.     }
  155.     /**
  156.      * @return string|null
  157.      */
  158.     public function getPrettyUrl()
  159.     {
  160.         return $this->prettyUrl;
  161.     }
  162.     /**
  163.      * Set linked Target Groups as set in properties panel as list of IDs
  164.      *
  165.      * @param string|array $targetGroupIds
  166.      */
  167.     public function setTargetGroupIds($targetGroupIds)
  168.     {
  169.         if (is_array($targetGroupIds)) {
  170.             $targetGroupIds implode(','$targetGroupIds);
  171.         }
  172.         $targetGroupIds trim($targetGroupIds' ,');
  173.         if (!empty($targetGroupIds)) {
  174.             $targetGroupIds ',' $targetGroupIds ',';
  175.         }
  176.         $this->targetGroupIds $targetGroupIds;
  177.     }
  178.     /**
  179.      * Get serialized list of Target Group IDs
  180.      *
  181.      * @return string
  182.      */
  183.     public function getTargetGroupIds(): string
  184.     {
  185.         return $this->targetGroupIds;
  186.     }
  187.     /**
  188.      * Set assigned target groups
  189.      *
  190.      * @param TargetGroup[]|int[] $targetGroups
  191.      */
  192.     public function setTargetGroups(array $targetGroups)
  193.     {
  194.         $ids array_map(function ($targetGroup) {
  195.             if (is_numeric($targetGroup)) {
  196.                 return (int)$targetGroup;
  197.             } elseif ($targetGroup instanceof TargetGroup) {
  198.                 return $targetGroup->getId();
  199.             }
  200.             return null;
  201.         }, $targetGroups);
  202.         $ids array_filter($ids, function ($id) {
  203.             return null !== $id && $id 0;
  204.         });
  205.         $this->setTargetGroupIds($ids);
  206.     }
  207.     /**
  208.      * Return list of assigned target groups (via properties panel)
  209.      *
  210.      * @return TargetGroup[]
  211.      */
  212.     public function getTargetGroups(): array
  213.     {
  214.         $ids explode(','$this->targetGroupIds);
  215.         $targetGroups array_map(function ($id) {
  216.             $id trim($id);
  217.             if (!empty($id)) {
  218.                 $targetGroup TargetGroup::getById($id);
  219.                 if ($targetGroup) {
  220.                     return $targetGroup;
  221.                 }
  222.             }
  223.         }, $ids);
  224.         $targetGroups array_filter($targetGroups);
  225.         return $targetGroups;
  226.     }
  227.     /**
  228.      * @param bool $hdpi
  229.      *
  230.      * @return string
  231.      */
  232.     public function getPreviewImageFilesystemPath($hdpi false)
  233.     {
  234.         $suffix '';
  235.         if ($hdpi) {
  236.             $suffix '@2x';
  237.         }
  238.         return PIMCORE_SYSTEM_TEMP_DIRECTORY '/document-page-previews/document-page-screenshot-' $this->getId() . $suffix '.jpg';
  239.     }
  240. }