vendor/pimcore/pimcore/models/Document/Editable/Link.php line 26

  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\Editable;
  19. use Pimcore\Logger;
  20. use Pimcore\Model;
  21. use Pimcore\Model\Asset;
  22. use Pimcore\Model\DataObject;
  23. use Pimcore\Model\Document;
  24. use Pimcore\Tool\Serialize;
  26. /**
  27.  * @method \Pimcore\Model\Document\Editable\Dao getDao()
  28.  */
  29. class Link extends Model\Document\Editable implements IdRewriterInterface, EditmodeDataInterface
  30. {
  31.     /**
  32.      * Contains the data for the link
  33.      *
  34.      * @internal
  35.      *
  36.      */
  37.     protected ?array $data = null;
  39.     public function getType(): string
  40.     {
  41.         return 'link';
  42.     }
  44.     public function getData(): mixed
  45.     {
  46.         // update path if internal link
  47.         $this->updatePathFromInternal(true);
  49.         return $this->data;
  50.     }
  52.     public function getDataEditmode(): ?array
  53.     {
  54.         // update path if internal link
  55.         $this->updatePathFromInternal(true, true);
  57.         return $this->data;
  58.     }
  60.     protected function getEditmodeElementClasses(array $options = []): array
  61.     {
  62.         // we don't want the class attribute being applied to the editable container element (<div>, only to the <a> tag inside
  63.         // the default behavior of the parent method is to include the "class" attribute
  64.         $classes = [
  65.             'pimcore_editable',
  66.             'pimcore_editable_' . $this->getType(),
  67.         ];
  69.         return $classes;
  70.     }
  72.     public function frontend()
  73.     {
  74.         $url = $this->getHref();
  76.         if (strlen($url) > 0) {
  77.             $prefix = '';
  78.             $suffix = '';
  79.             $noText = false;
  80.             $disabledText = false;
  82.             if (array_key_exists('textPrefix', $this->config)) {
  83.                 $prefix = $this->config['textPrefix'];
  84.                 unset($this->config['textPrefix']);
  85.             }
  87.             if (array_key_exists('textSuffix', $this->config)) {
  88.                 $suffix = $this->config['textSuffix'];
  89.                 unset($this->config['textSuffix']);
  90.             }
  92.             if (isset($this->config['noText']) && $this->config['noText'] == true) {
  93.                 $noText = true;
  94.                 unset($this->config['noText']);
  95.             }
  97.             if (array_key_exists('disabledFields', $this->config) && is_array($this->config['disabledFields'])) {
  98.                 $disabledText = in_array('text', $this->config['disabledFields'], true);
  99.                 unset($this->config['disabledFields']);
  100.             }
  102.             $this->data = is_array($this->data) ? $this->data : [];
  103.             $availableAttribs = array_merge($this->data, $this->config);
  105.             // add attributes to link
  106.             $attribs = [];
  107.             foreach ($availableAttribs as $key => $value) {
  108.                 if (is_string($value) || is_numeric($value)) {
  109.                     if (!empty($this->data[$key]) && !empty($this->config[$key])) {
  110.                         $attribs[] = $key.'="'. htmlspecialchars($this->data[$key]) .' '. htmlspecialchars($this->config[$key]) .'"';
  111.                     } elseif ($value) {
  112.                         $attribs[] = (is_string($value)) ?
  113.                             $key . '="' . htmlspecialchars($value) . '"' :
  114.                             $key . '="' . $value . '"';
  115.                     }
  116.                 }
  117.             }
  118.             $attribs = array_unique($attribs);
  120.             $text = '';
  121.             if (!$noText) {
  122.                 $text = htmlspecialchars($disabledText ? $url : ($this->data['text'] ?? $url));
  123.             }
  125.             return '<a href="'.$url.'" '.implode(' ', $attribs).'>' . $prefix . $text . $suffix . '</a>';
  126.         }
  128.         return '';
  129.     }
  131.     public function checkValidity(): bool
  132.     {
  133.         $sane = true;
  134.         if (is_array($this->data) && isset($this->data['internal']) && $this->data['internal']) {
  135.             if ($this->data['internalType'] == 'document') {
  136.                 $doc = Document::getById($this->data['internalId']);
  137.                 if (!$doc) {
  138.                     $sane = false;
  139.                     Logger::notice(
  140.                         'Detected insane relation, removing reference to non existent document with id ['.$this->getDocumentId(
  141.                         ).']'
  142.                     );
  143.                     $this->data = null;
  144.                 }
  145.             } elseif ($this->data['internalType'] == 'asset') {
  146.                 $asset = Asset::getById($this->data['internalId']);
  147.                 if (!$asset) {
  148.                     $sane = false;
  149.                     Logger::notice(
  150.                         'Detected insane relation, removing reference to non existent asset with id ['.$this->getDocumentId(
  151.                         ).']'
  152.                     );
  153.                     $this->data = null;
  154.                 }
  155.             } elseif ($this->data['internalType'] == 'object') {
  156.                 $object = Model\DataObject\Concrete::getById($this->data['internalId']);
  157.                 if (!$object) {
  158.                     $sane = false;
  159.                     Logger::notice(
  160.                         'Detected insane relation, removing reference to non existent object with id ['.$this->getDocumentId(
  161.                         ).']'
  162.                     );
  163.                     $this->data = null;
  164.                 }
  165.             }
  166.         }
  168.         return $sane;
  169.     }
  171.     public function getHref(): string
  172.     {
  173.         $this->updatePathFromInternal();
  175.         $url = $this->data['path'] ?? '';
  177.         if (strlen($this->data['parameters'] ?? '') > 0) {
  178.             $url .= (str_contains($url, '?') ? '&' : '?') . htmlspecialchars(str_replace('?', '', $this->getParameters()));
  179.         }
  181.         if (strlen($this->data['anchor'] ?? '') > 0) {
  182.             $anchor = str_replace('"', urlencode('"'), htmlspecialchars($this->getAnchor()));
  183.             $url .= '#' . str_replace('#', '', $anchor);
  184.         }
  186.         return $url;
  187.     }
  189.     private function updatePathFromInternal(bool $realPath = false, bool $editmode = false): void
  190.     {
  191.         $method = 'getFullPath';
  192.         if ($realPath) {
  193.             $method = 'getRealFullPath';
  194.         }
  196.         if (isset($this->data['internal']) && $this->data['internal']) {
  197.             if ($this->data['internalType'] == 'document') {
  198.                 if ($doc = Document::getById($this->data['internalId'])) {
  199.                     if ($editmode || (!Document::doHideUnpublished() || $doc->isPublished())) {
  200.                         $this->data['path'] = $doc->$method();
  201.                     } else {
  202.                         $this->data['path'] = '';
  203.                     }
  204.                 }
  205.             } elseif ($this->data['internalType'] == 'asset') {
  206.                 if ($asset = Asset::getById($this->data['internalId'])) {
  207.                     $this->data['path'] = $asset->$method();
  208.                 }
  209.             } elseif ($this->data['internalType'] == 'object') {
  210.                 if ($object = Model\DataObject::getById($this->data['internalId'])) {
  211.                     if ($editmode) {
  212.                         $this->data['path'] = $object->getFullPath();
  213.                     } else {
  214.                         if ($object instanceof Model\DataObject\Concrete) {
  215.                             if ($linkGenerator = $object->getClass()->getLinkGenerator()) {
  216.                                 if ($realPath) {
  217.                                     $this->data['path'] = $object->getFullPath();
  218.                                 } else {
  219.                                     $this->data['path'] = $linkGenerator->generate(
  220.                                         $object,
  221.                                         [
  222.                                             'document' => $this->getDocument(),
  223.                                             'context' => $this,
  224.                                         ]
  225.                                     );
  226.                                 }
  227.                             }
  228.                         }
  229.                     }
  230.                 }
  231.             }
  232.         }
  234.         // deletes unnecessary attribute, which was set by mistake in earlier versions, see also
  235.         // https://github.com/pimcore/pimcore/issues/7394
  236.         if (isset($this->data['type'])) {
  237.             unset($this->data['type']);
  238.         }
  239.     }
  241.     public function getText(): string
  242.     {
  243.         return $this->data['text'] ?? '';
  244.     }
  246.     public function setText(string $text): void
  247.     {
  248.         $this->data['text'] = $text;
  249.     }
  251.     public function getTarget(): string
  252.     {
  253.         return $this->data['target'] ?? '';
  254.     }
  256.     public function getParameters(): string
  257.     {
  258.         return $this->data['parameters'] ?? '';
  259.     }
  261.     public function getAnchor(): string
  262.     {
  263.         return $this->data['anchor'] ?? '';
  264.     }
  266.     public function getTitle(): string
  267.     {
  268.         return $this->data['title'] ?? '';
  269.     }
  271.     public function getRel(): string
  272.     {
  273.         return $this->data['rel'] ?? '';
  274.     }
  276.     public function getTabindex(): string
  277.     {
  278.         return $this->data['tabindex'] ?? '';
  279.     }
  281.     public function getAccesskey(): string
  282.     {
  283.         return $this->data['accesskey'] ?? '';
  284.     }
  286.     public function getClass(): mixed
  287.     {
  288.         return $this->data['class'] ?? '';
  289.     }
  291.     public function setDataFromResource(mixed $data): static
  292.     {
  293.         if (is_string($data)) {
  294.             $data = Serialize::unserialize($data);
  295.         }
  296.         if (is_array($data) || is_null($data)) {
  297.             $this->data = $data;
  298.         }
  300.         return $this;
  301.     }
  303.     public function setDataFromEditmode(mixed $data): static
  304.     {
  305.         if (!is_array($data)) {
  306.             $data = [];
  307.         }
  309.         $path = $data['path'] ?? null;
  311.         if (!empty($path)) {
  312.             $target = null;
  314.             if ($data['linktype'] == 'internal' && $data['internalType']) {
  315.                 $target = Model\Element\Service::getElementByPath($data['internalType'], $path);
  316.                 if ($target) {
  317.                     $data['internal'] = true;
  318.                     $data['internalId'] = $target->getId();
  319.                 }
  320.             }
  322.             if (!$target) {
  323.                 if ($target = Document::getByPath($path)) {
  324.                     $data['internal'] = true;
  325.                     $data['internalId'] = $target->getId();
  326.                     $data['internalType'] = 'document';
  327.                 } elseif ($target = Asset::getByPath($path)) {
  328.                     $data['internal'] = true;
  329.                     $data['internalId'] = $target->getId();
  330.                     $data['internalType'] = 'asset';
  331.                 } elseif ($target = Model\DataObject\Concrete::getByPath($path)) {
  332.                     $data['internal'] = true;
  333.                     $data['internalId'] = $target->getId();
  334.                     $data['internalType'] = 'object';
  335.                 } else {
  336.                     $data['internal'] = false;
  337.                     $data['internalId'] = null;
  338.                     $data['internalType'] = null;
  339.                     $data['linktype'] = 'direct';
  340.                 }
  342.                 if ($target) {
  343.                     $data['linktype'] = 'internal';
  344.                 }
  345.             }
  346.         }
  348.         $this->data = $data;
  350.         return $this;
  351.     }
  353.     public function isEmpty(): bool
  354.     {
  355.         return strlen($this->getHref()) < 1;
  356.     }
  358.     public function resolveDependencies(): array
  359.     {
  360.         $dependencies = [];
  361.         $isInternal = $this->data['internal'] ?? false;
  363.         if (is_array($this->data) && $isInternal) {
  364.             if ((int)$this->data['internalId'] > 0) {
  365.                 if ($this->data['internalType'] == 'document') {
  366.                     if ($doc = Document::getById($this->data['internalId'])) {
  367.                         $key = 'document_'.$doc->getId();
  369.                         $dependencies[$key] = [
  370.                             'id' => $doc->getId(),
  371.                             'type' => 'document',
  372.                         ];
  373.                     }
  374.                 } elseif ($this->data['internalType'] == 'asset') {
  375.                     if ($asset = Asset::getById($this->data['internalId'])) {
  376.                         $key = 'asset_' . $asset->getId();
  378.                         $dependencies[$key] = [
  379.                             'id' => $asset->getId(),
  380.                             'type' => 'asset',
  381.                         ];
  382.                     }
  383.                 } elseif ($this->data['internalType'] == 'object') {
  384.                     if ($object = DataObject\Concrete::getById($this->data['internalId'])) {
  385.                         $key = 'object_' . $object->getId();
  387.                         $dependencies[$key] = [
  388.                             'id' => $object->getId(),
  389.                             'type' => 'object',
  390.                         ];
  391.                     }
  392.                 }
  393.             }
  394.         }
  396.         return $dependencies;
  397.     }
  399.     public function rewriteIds(array $idMapping): void
  400.     {
  401.         if (isset($this->data['internal']) && $this->data['internal']) {
  402.             $type = $this->data['internalType'];
  403.             $id = (int)$this->data['internalId'];
  405.             if (array_key_exists($type, $idMapping)) {
  406.                 if (array_key_exists($id, $idMapping[$type])) {
  407.                     $this->data['internalId'] = $idMapping[$type][$id];
  408.                     $this->getHref();
  409.                 }
  410.             }
  411.         }
  412.     }
  413. }