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

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 Commercial License (PCL)
  8.  * Full copyright and license information is available in
  9.  * LICENSE.md which is distributed with this source code.
  10.  *
  11.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  12.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  13.  */
  14. namespace Pimcore\Model\Document\Editable;
  15. use Pimcore\Logger;
  16. use Pimcore\Model;
  17. use Pimcore\Model\Asset;
  18. use Pimcore\Model\Document;
  19. /**
  20.  * @method \Pimcore\Model\Document\Editable\Dao getDao()
  21.  */
  22. class Link extends Model\Document\Editable implements IdRewriterInterfaceEditmodeDataInterface
  23. {
  24.     /**
  25.      * Contains the data for the link
  26.      *
  27.      * @internal
  28.      *
  29.      * @var array|null
  30.      */
  31.     protected $data;
  32.     /**
  33.      * {@inheritdoc}
  34.      */
  35.     public function getType()
  36.     {
  37.         return 'link';
  38.     }
  39.     /**
  40.      * {@inheritdoc}
  41.      */
  42.     public function getData()
  43.     {
  44.         // update path if internal link
  45.         $this->updatePathFromInternal(true);
  46.         return $this->data;
  47.     }
  48.     /**
  49.      * {@inheritdoc}
  50.      */
  51.     public function getDataEditmode() /** : mixed */
  52.     {
  53.         // update path if internal link
  54.         $this->updatePathFromInternal(truetrue);
  55.         return $this->data;
  56.     }
  57.     /**
  58.      * {@inheritdoc}
  59.      */
  60.     protected function getEditmodeElementClasses($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.         ];
  68.         return $classes;
  69.     }
  70.     /**
  71.      * {@inheritdoc}
  72.      */
  73.     public function frontend()
  74.     {
  75.         $url $this->getHref();
  76.         if (strlen($url) > 0) {
  77.             if (!is_array($this->config)) {
  78.                 $this->config = [];
  79.             }
  80.             $prefix '';
  81.             $suffix '';
  82.             $noText false;
  83.             if (array_key_exists('textPrefix'$this->config)) {
  84.                 $prefix $this->config['textPrefix'];
  85.                 unset($this->config['textPrefix']);
  86.             }
  87.             if (array_key_exists('textSuffix'$this->config)) {
  88.                 $suffix $this->config['textSuffix'];
  89.                 unset($this->config['textSuffix']);
  90.             }
  91.             if (isset($this->config['noText']) && $this->config['noText'] == true) {
  92.                 $noText true;
  93.                 unset($this->config['noText']);
  94.             }
  95.             // add attributes to link
  96.             $allowedAttributes = [
  97.                 'charset',
  98.                 'coords',
  99.                 'hreflang',
  100.                 'name',
  101.                 'rel',
  102.                 'rev',
  103.                 'shape',
  104.                 'target',
  105.                 'accesskey',
  106.                 'class',
  107.                 'dir',
  108.                 'draggable',
  109.                 'dropzone',
  110.                 'contextmenu',
  111.                 'id',
  112.                 'lang',
  113.                 'style',
  114.                 'tabindex',
  115.                 'title',
  116.                 'media',
  117.                 'download',
  118.                 'ping',
  119.                 'type',
  120.                 'referrerpolicy',
  121.                 'xml:lang',
  122.             ];
  123.             $defaultAttributes = [];
  124.             if (!is_array($this->data)) {
  125.                 $this->data = [];
  126.             }
  127.             $availableAttribs array_merge($defaultAttributes$this->data$this->config);
  128.             // add attributes to link
  129.             $attribs = [];
  130.             foreach ($availableAttribs as $key => $value) {
  131.                 if ((is_string($value) || is_numeric($value))
  132.                     && (strpos($key'data-') === ||
  133.                         strpos($key'aria-') === ||
  134.                         in_array($key$allowedAttributes))) {
  135.                     if (!empty($this->data[$key]) && !empty($this->config[$key])) {
  136.                         $attribs[] = $key.'="'htmlspecialchars($this->data[$key]) .' 'htmlspecialchars($this->config[$key]) .'"';
  137.                     } elseif (!empty($value)) {
  138.                         $attribs[] = $key.'="'.htmlspecialchars($value).'"';
  139.                     }
  140.                 }
  141.             }
  142.             $attribs array_unique($attribs);
  143.             if (array_key_exists('attributes'$this->data) && !empty($this->data['attributes'])) {
  144.                 $attribs[] = $this->data['attributes'];
  145.             }
  146.             return '<a href="'.$url.'" '.implode(' '$attribs).'>' $prefix . ($noText '' htmlspecialchars($this->data['text'])) . $suffix '</a>';
  147.         }
  148.         return '';
  149.     }
  150.     /**
  151.      * {@inheritdoc}
  152.      */
  153.     public function checkValidity()
  154.     {
  155.         $sane true;
  156.         if (is_array($this->data) && isset($this->data['internal']) && $this->data['internal']) {
  157.             if ($this->data['internalType'] == 'document') {
  158.                 $doc Document::getById($this->data['internalId']);
  159.                 if (!$doc) {
  160.                     $sane false;
  161.                     Logger::notice(
  162.                         'Detected insane relation, removing reference to non existent document with id ['.$this->getDocumentId(
  163.                         ).']'
  164.                     );
  165.                     $this->data null;
  166.                 }
  167.             } elseif ($this->data['internalType'] == 'asset') {
  168.                 $asset Asset::getById($this->data['internalId']);
  169.                 if (!$asset) {
  170.                     $sane false;
  171.                     Logger::notice(
  172.                         'Detected insane relation, removing reference to non existent asset with id ['.$this->getDocumentId(
  173.                         ).']'
  174.                     );
  175.                     $this->data null;
  176.                 }
  177.             } elseif ($this->data['internalType'] == 'object') {
  178.                 $object Model\DataObject\Concrete::getById($this->data['internalId']);
  179.                 if (!$object) {
  180.                     $sane false;
  181.                     Logger::notice(
  182.                         'Detected insane relation, removing reference to non existent object with id ['.$this->getDocumentId(
  183.                         ).']'
  184.                     );
  185.                     $this->data null;
  186.                 }
  187.             }
  188.         }
  189.         return $sane;
  190.     }
  191.     /**
  192.      * @return string
  193.      */
  194.     public function getHref()
  195.     {
  196.         $this->updatePathFromInternal();
  197.         $url $this->data['path'] ?? '';
  198.         if (strlen($this->data['parameters'] ?? '') > 0) {
  199.             $url .= (strpos($url'?') !== false '&' '?') . htmlspecialchars(str_replace('?'''$this->getParameters()));
  200.         }
  201.         if (strlen($this->data['anchor'] ?? '') > 0) {
  202.             $anchor str_replace('"'urlencode('"'), htmlspecialchars($this->getAnchor()));
  203.             $url .= '#' str_replace('#'''$anchor);
  204.         }
  205.         return $url;
  206.     }
  207.     /**
  208.      * @param bool $realPath
  209.      * @param bool $editmode
  210.      */
  211.     private function updatePathFromInternal($realPath false$editmode false)
  212.     {
  213.         $method 'getFullPath';
  214.         if ($realPath) {
  215.             $method 'getRealFullPath';
  216.         }
  217.         if (isset($this->data['internal']) && $this->data['internal']) {
  218.             if ($this->data['internalType'] == 'document') {
  219.                 if ($doc Document::getById($this->data['internalId'])) {
  220.                     if ($editmode || (!Document::doHideUnpublished() || $doc->isPublished())) {
  221.                         $this->data['path'] = $doc->$method();
  222.                     } else {
  223.                         $this->data['path'] = '';
  224.                     }
  225.                 }
  226.             } elseif ($this->data['internalType'] == 'asset') {
  227.                 if ($asset Asset::getById($this->data['internalId'])) {
  228.                     $this->data['path'] = $asset->$method();
  229.                 }
  230.             } elseif ($this->data['internalType'] == 'object') {
  231.                 if ($object Model\DataObject::getById($this->data['internalId'])) {
  232.                     if ($editmode) {
  233.                         $this->data['path'] = $object->getFullPath();
  234.                     } else {
  235.                         if ($object instanceof Model\DataObject\Concrete) {
  236.                             if ($linkGenerator $object->getClass()->getLinkGenerator()) {
  237.                                 if ($realPath) {
  238.                                     $this->data['path'] = $object->getFullPath();
  239.                                 } else {
  240.                                     $this->data['path'] = $linkGenerator->generate(
  241.                                         $object,
  242.                                         [
  243.                                             'document' => $this->getDocument(),
  244.                                             'context' => $this,
  245.                                         ]
  246.                                     );
  247.                                 }
  248.                             }
  249.                         }
  250.                     }
  251.                 }
  252.             }
  253.         }
  254.         // sanitize attributes
  255.         if ($this->getEditmode() === false && isset($this->data['attributes'])) {
  256.             $this->data['attributes'] = htmlspecialchars($this->data['attributes'], HTML_ENTITIES);
  257.         }
  258.         // deletes unnecessary attribute, which was set by mistake in earlier versions, see also
  259.         // https://github.com/pimcore/pimcore/issues/7394
  260.         if (isset($this->data['type'])) {
  261.             unset($this->data['type']);
  262.         }
  263.     }
  264.     /**
  265.      * @return string
  266.      */
  267.     public function getText()
  268.     {
  269.         return $this->data['text'] ?? '';
  270.     }
  271.     /**
  272.      * @param string $text
  273.      */
  274.     public function setText($text)
  275.     {
  276.         $this->data['text'] = $text;
  277.     }
  278.     /**
  279.      * @return string
  280.      */
  281.     public function getTarget()
  282.     {
  283.         return $this->data['target'] ?? '';
  284.     }
  285.     /**
  286.      * @return string
  287.      */
  288.     public function getParameters()
  289.     {
  290.         return $this->data['parameters'] ?? '';
  291.     }
  292.     /**
  293.      * @return string
  294.      */
  295.     public function getAnchor()
  296.     {
  297.         return $this->data['anchor'] ?? '';
  298.     }
  299.     /**
  300.      * @return string
  301.      */
  302.     public function getTitle()
  303.     {
  304.         return $this->data['title'] ?? '';
  305.     }
  306.     /**
  307.      * @return string
  308.      */
  309.     public function getRel()
  310.     {
  311.         return $this->data['rel'] ?? '';
  312.     }
  313.     /**
  314.      * @return string
  315.      */
  316.     public function getTabindex()
  317.     {
  318.         return $this->data['tabindex'] ?? '';
  319.     }
  320.     /**
  321.      * @return string
  322.      */
  323.     public function getAccesskey()
  324.     {
  325.         return $this->data['accesskey'] ?? '';
  326.     }
  327.     /**
  328.      * @return mixed
  329.      */
  330.     public function getClass()
  331.     {
  332.         return $this->data['class'] ?? '';
  333.     }
  334.     /**
  335.      * @return mixed
  336.      */
  337.     public function getAttributes()
  338.     {
  339.         return $this->data['attributes'] ?? '';
  340.     }
  341.     /**
  342.      * {@inheritdoc}
  343.      */
  344.     public function setDataFromResource($data)
  345.     {
  346.         $this->data \Pimcore\Tool\Serialize::unserialize($data);
  347.         if (!is_array($this->data)) {
  348.             $this->data = [];
  349.         }
  350.         return $this;
  351.     }
  352.     /**
  353.      * {@inheritdoc}
  354.      */
  355.     public function setDataFromEditmode($data)
  356.     {
  357.         if (!is_array($data)) {
  358.             $data = [];
  359.         }
  360.         $path $data['path'] ?? null;
  361.         if (!empty($path)) {
  362.             $target null;
  363.             if ($data['linktype'] == 'internal' && $data['internalType']) {
  364.                 $target Model\Element\Service::getElementByPath($data['internalType'], $path);
  365.                 if ($target) {
  366.                     $data['internal'] = true;
  367.                     $data['internalId'] = $target->getId();
  368.                 }
  369.             }
  370.             if (!$target) {
  371.                 if ($target Document::getByPath($path)) {
  372.                     $data['internal'] = true;
  373.                     $data['internalId'] = $target->getId();
  374.                     $data['internalType'] = 'document';
  375.                 } elseif ($target Asset::getByPath($path)) {
  376.                     $data['internal'] = true;
  377.                     $data['internalId'] = $target->getId();
  378.                     $data['internalType'] = 'asset';
  379.                 } elseif ($target Model\DataObject\Concrete::getByPath($path)) {
  380.                     $data['internal'] = true;
  381.                     $data['internalId'] = $target->getId();
  382.                     $data['internalType'] = 'object';
  383.                 } else {
  384.                     $data['internal'] = false;
  385.                     $data['internalId'] = null;
  386.                     $data['internalType'] = null;
  387.                     $data['linktype'] = 'direct';
  388.                 }
  389.                 if ($target) {
  390.                     $data['linktype'] = 'internal';
  391.                 }
  392.             }
  393.         }
  394.         $this->data $data;
  395.         return $this;
  396.     }
  397.     /**
  398.      * {@inheritdoc}
  399.      */
  400.     public function isEmpty()
  401.     {
  402.         return strlen($this->getHref()) < 1;
  403.     }
  404.     /**
  405.      * {@inheritdoc}
  406.      */
  407.     public function resolveDependencies()
  408.     {
  409.         $dependencies = [];
  410.         $isInternal $this->data['internal'] ?? false;
  411.         if (is_array($this->data) && $isInternal) {
  412.             if ((int)$this->data['internalId'] > 0) {
  413.                 if ($this->data['internalType'] == 'document') {
  414.                     if ($doc Document::getById($this->data['internalId'])) {
  415.                         $key 'document_'.$doc->getId();
  416.                         $dependencies[$key] = [
  417.                             'id' => $doc->getId(),
  418.                             'type' => 'document',
  419.                         ];
  420.                     }
  421.                 } elseif ($this->data['internalType'] == 'asset') {
  422.                     if ($asset Asset::getById($this->data['internalId'])) {
  423.                         $key 'asset_'.$asset->getId();
  424.                         $dependencies[$key] = [
  425.                             'id' => $asset->getId(),
  426.                             'type' => 'asset',
  427.                         ];
  428.                     }
  429.                 }
  430.             }
  431.         }
  432.         return $dependencies;
  433.     }
  434.     /**
  435.      * { @inheritdoc }
  436.      */
  437.     public function rewriteIds($idMapping/** : void */
  438.     {
  439.         if (isset($this->data['internal']) && $this->data['internal']) {
  440.             $type $this->data['internalType'];
  441.             $id = (int)$this->data['internalId'];
  442.             if (array_key_exists($type$idMapping)) {
  443.                 if (array_key_exists($id$idMapping[$type])) {
  444.                     $this->data['internalId'] = $idMapping[$type][$id];
  445.                     $this->getHref();
  446.                 }
  447.             }
  448.         }
  449.     }
  450. }