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

  1. <?php
  2. declare(strict_types=1);
  4. /**
  5.  * Pimcore
  6.  *
  7.  * This source file is available under two different licenses:
  8.  * - GNU General Public License version 3 (GPLv3)
  9.  * - Pimcore Commercial License (PCL)
  10.  * Full copyright and license information is available in
  11.  * LICENSE.md which is distributed with this source code.
  12.  *
  13.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  14.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  15.  */
  17. namespace Pimcore\Model\Document;
  19. use Pimcore\Messenger\GeneratePagePreviewMessage;
  21. /**
  22.  * @method \Pimcore\Model\Document\Page\Dao getDao()
  23.  */
  24. class Page extends PageSnippet
  25. {
  26.     /**
  27.      * Contains the title of the page (meta-title)
  28.      *
  29.      * @internal
  30.      *
  31.      * @var string
  32.      */
  33.     protected string $title = '';
  35.     /**
  36.      * Contains the description of the page (meta-description)
  37.      *
  38.      * @internal
  39.      *
  40.      * @var string
  41.      */
  42.     protected string $description = '';
  44.     /**
  45.      * {@inheritdoc}
  46.      */
  47.     protected string $type = 'page';
  49.     /**
  50.      * @internal
  51.      *
  52.      * @var string|null
  53.      */
  54.     protected ?string $prettyUrl = null;
  56.     public function getDescription(): string
  57.     {
  58.         return $this->description;
  59.     }
  61.     public function getTitle(): string
  62.     {
  63.         return \Pimcore\Tool\Text::removeLineBreaks($this->title);
  64.     }
  66.     public function setDescription(string $description): static
  67.     {
  68.         $this->description = str_replace("\n", ' ', $description);
  70.         return $this;
  71.     }
  73.     public function setTitle(string $title): static
  74.     {
  75.         $this->title = $title;
  77.         return $this;
  78.     }
  80.     public function getFullPath(bool $force = false): string
  81.     {
  82.         $path = parent::getFullPath($force);
  84.         // 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
  85.         if (!\Pimcore::inAdmin() && !($this instanceof Hardlink\Wrapper\WrapperInterface) && \Pimcore\Tool\Frontend::isDocumentInCurrentSite($this)) {
  86.             // check for a pretty url
  87.             $prettyUrl = $this->getPrettyUrl();
  88.             if (!empty($prettyUrl) && strlen($prettyUrl) > 1) {
  89.                 return $prettyUrl;
  90.             }
  91.         }
  93.         return $path;
  94.     }
  96.     public function setPrettyUrl(?string $prettyUrl): static
  97.     {
  98.         if (!$prettyUrl) {
  99.             $this->prettyUrl = null;
  100.         } else {
  101.             $this->prettyUrl = '/' . trim($prettyUrl, ' /');
  102.             if (strlen($this->prettyUrl) < 2) {
  103.                 $this->prettyUrl = null;
  104.             }
  105.         }
  107.         return $this;
  108.     }
  110.     public function getPrettyUrl(): ?string
  111.     {
  112.         return $this->prettyUrl;
  113.     }
  115.     public function getPreviewImageFilesystemPath(): string
  116.     {
  117.         return PIMCORE_SYSTEM_TEMP_DIRECTORY . '/document-page-previews/document-page-screenshot-' . $this->getId() . '@2x.jpg';
  118.     }
  120.     public function save(array $parameters = []): static
  121.     {
  122.         $page = parent::save($parameters);
  124.         // Dispatch page preview message, if preview is enabled.
  125.         $documentsConfig = \Pimcore\Config::getSystemConfiguration('documents');
  126.         if ($documentsConfig['generate_preview'] ?? false) {
  127.             \Pimcore::getContainer()->get('messenger.bus.pimcore-core')->dispatch(
  128.                 new GeneratePagePreviewMessage($this->getId(), \Pimcore\Tool::getHostUrl())
  129.             );
  130.         }
  132.         return $page;
  133.     }
  134. }