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

  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.      */
  32.     protected string $title = '';
  34.     /**
  35.      * Contains the description of the page (meta-description)
  36.      *
  37.      * @internal
  38.      *
  39.      */
  40.     protected string $description = '';
  42.     protected string $type = 'page';
  44.     /**
  45.      * @internal
  46.      *
  47.      */
  48.     protected ?string $prettyUrl = null;
  50.     public function getDescription(): string
  51.     {
  52.         return $this->description;
  53.     }
  55.     public function getTitle(): string
  56.     {
  57.         return \Pimcore\Tool\Text::removeLineBreaks($this->title);
  58.     }
  60.     public function setDescription(string $description): static
  61.     {
  62.         $this->description = str_replace("\n", ' ', $description);
  64.         return $this;
  65.     }
  67.     public function setTitle(string $title): static
  68.     {
  69.         $this->title = $title;
  71.         return $this;
  72.     }
  74.     public function getFullPath(bool $force = false): string
  75.     {
  76.         $path = parent::getFullPath($force);
  78.         // 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
  79.         if (!\Pimcore::inAdmin() && !($this instanceof Hardlink\Wrapper\WrapperInterface) && \Pimcore\Tool\Frontend::isDocumentInCurrentSite($this)) {
  80.             // check for a pretty url
  81.             $prettyUrl = $this->getPrettyUrl();
  82.             if (!empty($prettyUrl) && strlen($prettyUrl) > 1) {
  83.                 return $prettyUrl;
  84.             }
  85.         }
  87.         return $path;
  88.     }
  90.     public function setPrettyUrl(?string $prettyUrl): static
  91.     {
  92.         if (!$prettyUrl) {
  93.             $this->prettyUrl = null;
  94.         } else {
  95.             $this->prettyUrl = '/' . trim($prettyUrl, ' /');
  96.             if (strlen($this->prettyUrl) < 2) {
  97.                 $this->prettyUrl = null;
  98.             }
  99.         }
  101.         return $this;
  102.     }
  104.     public function getPrettyUrl(): ?string
  105.     {
  106.         return $this->prettyUrl;
  107.     }
  109.     public function getPreviewImageFilesystemPath(): string
  110.     {
  111.         return PIMCORE_SYSTEM_TEMP_DIRECTORY . '/document-page-previews/document-page-screenshot-' . $this->getId() . '@2x.jpg';
  112.     }
  114.     public function save(array $parameters = []): static
  115.     {
  116.         $page = parent::save($parameters);
  118.         // Dispatch page preview message, if preview is enabled.
  119.         $documentsConfig = \Pimcore\Config::getSystemConfiguration('documents');
  120.         if ($documentsConfig['generate_preview'] ?? false) {
  121.             \Pimcore::getContainer()->get('messenger.bus.pimcore-core')->dispatch(
  122.                 new GeneratePagePreviewMessage($this->getId(), \Pimcore\Tool::getHostUrl())
  123.             );
  124.         }
  126.         return $page;
  127.     }
  128. }