vendor/sulu/sulu/src/Sulu/Bundle/MarkupBundle/Markup/LinkTag.php line 185

  1. <?php
  3. /*
  4.  * This file is part of Sulu.
  5.  *
  6.  * (c) Sulu GmbH
  7.  *
  8.  * This source file is subject to the MIT license that is bundled
  9.  * with this source code in the file LICENSE.
  10.  */
  12. namespace Sulu\Bundle\MarkupBundle\Markup;
  14. use Sulu\Bundle\MarkupBundle\Markup\Link\LinkItem;
  15. use Sulu\Bundle\MarkupBundle\Markup\Link\LinkProviderPoolInterface;
  16. use Sulu\Bundle\MarkupBundle\Tag\TagInterface;
  17. use Symfony\Component\HttpFoundation\UrlHelper;
  19. class LinkTag implements TagInterface
  20. {
  21.     public const VALIDATE_UNPUBLISHED = 'unpublished';
  23.     public const VALIDATE_REMOVED = 'removed';
  25.     public const DEFAULT_PROVIDER = 'page';
  27.     /**
  28.      * @var LinkProviderPoolInterface
  29.      */
  30.     private $linkProviderPool;
  32.     /**
  33.      * @var bool
  34.      */
  35.     private $isPreview;
  37.     /**
  38.      * @var UrlHelper
  39.      */
  40.     private $urlHelper;
  42.     /**
  43.      * @var ?string
  44.      */
  45.     private $providerAttribute;
  47.     public function __construct(
  48.         LinkProviderPoolInterface $linkProviderPool,
  49.         bool $isPreview = false,
  50.         UrlHelper $urlHelper = null,
  51.         ?string $providerAttribute = null
  52.     ) {
  53.         $this->linkProviderPool = $linkProviderPool;
  54.         $this->isPreview = $isPreview;
  55.         $this->urlHelper = $urlHelper;
  56.         $this->providerAttribute = $providerAttribute;
  58.         if (null === $this->urlHelper) {
  59.             @\trigger_error(
  60.                 'Instantiating the LinkTag class without the $urlHelper argument is deprecated.',
  61.                 \E_USER_DEPRECATED
  62.             );
  63.         }
  64.     }
  66.     public function parseAll(array $attributesByTag, $locale)
  67.     {
  68.         $contents = $this->preload($attributesByTag, $locale);
  70.         $result = [];
  71.         foreach ($attributesByTag as $tag => $attributes) {
  72.             $provider = $this->getValue($attributes, 'provider', self::DEFAULT_PROVIDER);
  73.             $validationState = $attributes['sulu-validation-state'] ?? null;
  75.             $hrefParts = $this->getPartsFromHref($attributes['href'] ?? null);
  76.             $uuid = $hrefParts['uuid'];
  77.             $anchor = $hrefParts['anchor'];
  78.             $query = $hrefParts['query'];
  80.             if ($uuid && \array_key_exists($provider . '-' . $uuid, $contents)) {
  81.                 $item = $contents[$provider . '-' . $uuid];
  83.                 $url = $item->getUrl();
  84.                 if ($this->urlHelper) {
  85.                     $url = $this->urlHelper->getAbsoluteUrl($url);
  86.                 }
  88.                 if ($query) {
  89.                     $url .= '?' . $query;
  90.                 }
  92.                 if ($anchor) {
  93.                     $url .= '#' . $anchor;
  94.                 }
  96.                 $title = $item->getTitle();
  97.                 $attributes['href'] = $url;
  98.             } elseif ($this->isPreview && self::VALIDATE_UNPUBLISHED === $validationState) {
  99.                 // render anchor without href to keep styling even if target is not published in preview
  100.                 $title = $this->getContent($attributes);
  101.                 $attributes['href'] = null;
  102.             } else {
  103.                 // only render text instead of anchor to prevent dead links on website
  104.                 $result[$tag] = $this->getContent($attributes);
  106.                 continue;
  107.             }
  109.             $htmlAttributes = \array_map(
  110.                 function($value, $name) use ($attributes) {
  111.                     if (empty($value) || \in_array($name, ['content', 'sulu-validation-state'])) {
  112.                         return null;
  113.                     }
  115.                     if ('provider' === $name) {
  116.                         if (null === $this->providerAttribute || \array_key_exists($this->providerAttribute, $attributes)) {
  117.                             return null;
  118.                         }
  120.                         return \sprintf('%s="%s"', $this->providerAttribute, $value);
  121.                     }
  123.                     return \sprintf('%s="%s"', $name, $value);
  124.                 },
  125.                 $attributes,
  126.                 \array_keys($attributes)
  127.             );
  129.             $result[$tag] = \sprintf(
  130.                 '<a %s>%s</a>',
  131.                 \implode(' ', \array_filter($htmlAttributes)),
  132.                 $this->getValue($attributes, 'content', $title)
  133.             );
  134.         }
  136.         return $result;
  137.     }
  139.     public function validateAll(array $attributesByTag, $locale)
  140.     {
  141.         $items = $this->preload($attributesByTag, $locale, false);
  143.         $result = [];
  144.         foreach ($attributesByTag as $tag => $attributes) {
  145.             $provider = $this->getValue($attributes, 'provider', self::DEFAULT_PROVIDER);
  146.             $uuid = $this->getPartsFromHref($attributes['href'] ?? null)['uuid'];
  148.             if (!$uuid || !\array_key_exists($provider . '-' . $uuid, $items)) {
  149.                 $result[$tag] = self::VALIDATE_REMOVED;
  150.             } elseif (!$items[$provider . '-' . $uuid]->isPublished()) {
  151.                 $result[$tag] = self::VALIDATE_UNPUBLISHED;
  152.             }
  153.         }
  155.         return $result;
  156.     }
  158.     /**
  159.      * Return items for given attributes.
  160.      *
  161.      * @param array $attributesByTag
  162.      * @param string $locale
  163.      * @param bool $published
  164.      *
  165.      * @return LinkItem[]
  166.      */
  167.     private function preload($attributesByTag, $locale, $published = true)
  168.     {
  169.         $uuidsByType = [];
  170.         foreach ($attributesByTag as $attributes) {
  171.             $provider = $this->getValue($attributes, 'provider', self::DEFAULT_PROVIDER);
  172.             if (!\array_key_exists($provider, $uuidsByType)) {
  173.                 $uuidsByType[$provider] = [];
  174.             }
  176.             $uuid = $this->getPartsFromHref($attributes['href'] ?? null)['uuid'];
  178.             if ($uuid) {
  179.                 $uuidsByType[$provider][] = $uuid;
  180.             }
  181.         }
  183.         $result = [];
  184.         foreach ($uuidsByType as $provider => $uuids) {
  185.             $items = $this->linkProviderPool->getProvider($provider)->preload(
  186.                 \array_unique($uuids),
  187.                 $locale,
  188.                 $published
  189.             );
  191.             foreach ($items as $item) {
  192.                 $result[$provider . '-' . $item->getId()] = $item;
  193.             }
  194.         }
  196.         return $result;
  197.     }
  199.     /**
  200.      * Returns attribute identified by name or default if not exists.
  201.      *
  202.      * @param string $name
  203.      */
  204.     private function getValue(array $attributes, $name, $default = null)
  205.     {
  206.         if (\array_key_exists($name, $attributes) && !empty($attributes[$name])) {
  207.             return $attributes[$name];
  208.         }
  210.         return $default;
  211.     }
  213.     /**
  214.      * Returns content or title of given attributes.
  215.      *
  216.      * @return string
  217.      */
  218.     private function getContent(array $attributes)
  219.     {
  220.         if (\array_key_exists('content', $attributes)) {
  221.             return $attributes['content'];
  222.         }
  224.         return $this->getValue($attributes, 'title', '');
  225.     }
  227.     /**
  228.      * @param mixed $href
  229.      *
  230.      * @return array{uuid: string|null, query: string|null, anchor: string|null}
  231.      */
  232.     private function getPartsFromHref($href): array
  233.     {
  234.         $href = (string) $href ?: null;
  236.         /** @var string[] $hrefParts */
  237.         $hrefParts = $href ? \explode('#', $href, 2) : [];
  238.         $anchor = $hrefParts[1] ?? null;
  240.         $hrefParts = $hrefParts ? \explode('?', $hrefParts[0], 2) : [];
  241.         $uuid = $hrefParts[0] ?? null;
  242.         $query = $hrefParts[1] ?? null;
  244.         return [
  245.             'uuid' => $uuid,
  246.             'anchor' => $anchor,
  247.             'query' => $query,
  248.         ];
  249.     }
  250. }