123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102 |
- <?php
- namespace Drupal\Core\Render\Element;
- use Drupal\Component\Utility\NestedArray;
- use Drupal\Component\Utility\Html as HtmlUtility;
- use Drupal\Core\Render\BubbleableMetadata;
- use Drupal\Core\Url as CoreUrl;
- /**
- * Provides a link render element.
- *
- * Properties:
- * - #title: The link text.
- * - #url: \Drupal\Core\Url object containing URL information pointing to a
- * internal or external link. See \Drupal\Core\Utility\LinkGeneratorInterface.
- *
- * Usage example:
- * @code
- * $build['examples_link'] = [
- * '#title' => $this->t('Examples'),
- * '#type' => 'link',
- * '#url' => \Drupal\Core\Url::fromRoute('examples.description')
- * ];
- * @endcode
- *
- * @RenderElement("link")
- */
- class Link extends RenderElement {
- /**
- * {@inheritdoc}
- */
- public function getInfo() {
- $class = get_class($this);
- return [
- '#pre_render' => [
- [$class, 'preRenderLink'],
- ],
- ];
- }
- /**
- * Pre-render callback: Renders a link into #markup.
- *
- * Doing so during pre_render gives modules a chance to alter the link parts.
- *
- * @param array $element
- * A structured array whose keys form the arguments to
- * \Drupal\Core\Utility\LinkGeneratorInterface::generate():
- * - #title: The link text.
- * - #url: The URL info either pointing to a route or a non routed path.
- * - #options: (optional) An array of options to pass to the link generator.
- *
- * @return array
- * The passed-in element containing a rendered link in '#markup'.
- */
- public static function preRenderLink($element) {
- // By default, link options to pass to the link generator are normally set
- // in #options.
- $element += ['#options' => []];
- // However, within the scope of renderable elements, #attributes is a valid
- // way to specify attributes, too. Take them into account, but do not override
- // attributes from #options.
- if (isset($element['#attributes'])) {
- $element['#options'] += ['attributes' => []];
- $element['#options']['attributes'] += $element['#attributes'];
- }
- // This #pre_render callback can be invoked from inside or outside of a Form
- // API context, and depending on that, a HTML ID may be already set in
- // different locations. #options should have precedence over Form API's #id.
- // #attributes have been taken over into #options above already.
- if (isset($element['#options']['attributes']['id'])) {
- $element['#id'] = $element['#options']['attributes']['id'];
- }
- elseif (isset($element['#id'])) {
- $element['#options']['attributes']['id'] = $element['#id'];
- }
- // Conditionally invoke self::preRenderAjaxForm(), if #ajax is set.
- if (isset($element['#ajax']) && !isset($element['#ajax_processed'])) {
- // If no HTML ID was found above, automatically create one.
- if (!isset($element['#id'])) {
- $element['#id'] = $element['#options']['attributes']['id'] = HtmlUtility::getUniqueId('ajax-link');
- }
- $element = static::preRenderAjaxForm($element);
- }
- if (!empty($element['#url']) && $element['#url'] instanceof CoreUrl) {
- $options = NestedArray::mergeDeep($element['#url']->getOptions(), $element['#options']);
- /** @var \Drupal\Core\Utility\LinkGenerator $link_generator */
- $link_generator = \Drupal::service('link_generator');
- $generated_link = $link_generator->generate($element['#title'], $element['#url']->setOptions($options));
- $element['#markup'] = $generated_link;
- $generated_link->merge(BubbleableMetadata::createFromRenderArray($element))
- ->applyTo($element);
- }
- return $element;
- }
- }
|