class SystemCompactLink

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Render/Element/SystemCompactLink.php \Drupal\Core\Render\Element\SystemCompactLink
  2. 8.9.x core/lib/Drupal/Core/Render/Element/SystemCompactLink.php \Drupal\Core\Render\Element\SystemCompactLink
  3. 11.x core/lib/Drupal/Core/Render/Element/SystemCompactLink.php \Drupal\Core\Render\Element\SystemCompactLink

Provides a link to show or hide help text on administration pages.

Usage example:

$form['system_compact_link'] = [
  '#type' => 'system_compact_link',
];

Attributes

#[RenderElement('system_compact_link')]

Hierarchy

Expanded class hierarchy of SystemCompactLink

File

core/lib/Drupal/Core/Render/Element/SystemCompactLink.php, line 20

Namespace

Drupal\Core\Render\Element
View source
class SystemCompactLink extends Link {
  
  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = static::class;
    return [
      '#pre_render' => [
        [
          $class,
          'preRenderCompactLink',
        ],
        [
          $class,
          'preRenderLink',
        ],
      ],
      '#theme_wrappers' => [
        'container' => [
          '#attributes' => [
            'class' => [
              'compact-link',
            ],
          ],
        ],
      ],
    ];
  }
  
  /**
   * 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::l():
   *   - #title: The link text to pass as argument to Drupal::l().
   *   - One of the following:
   *     - #route_name and (optionally) a #route_parameters array; The route
   *       name and route parameters which will be passed into the link
   *       generator.
   *     - #href: The system path or URL to pass as argument to Drupal::l().
   *   - #options: (optional) An array of options to pass to Drupal::l() or the
   *     link generator.
   *
   * @return array
   *   The passed-in element containing the system compact link default values.
   */
  public static function preRenderCompactLink($element) {
    // By default, link options to pass to l() are normally set in #options.
    $element += [
      '#options' => [],
    ];
    if (system_admin_compact_mode()) {
      $element['#title'] = t('Show descriptions');
      $element['#url'] = BaseUrl::fromRoute('system.admin_compact_page', [
        'mode' => 'off',
      ]);
      $element['#options'] = [
        'attributes' => [
          'title' => t('Expand layout to include descriptions.'),
        ],
        'query' => \Drupal::destination()->getAsArray(),
      ];
    }
    else {
      $element['#title'] = t('Hide descriptions');
      $element['#url'] = BaseUrl::fromRoute('system.admin_compact_page', [
        'mode' => 'on',
      ]);
      $element['#options'] = [
        'attributes' => [
          'title' => t('Compress layout by hiding descriptions.'),
        ],
        'query' => \Drupal::destination()->getAsArray(),
      ];
    }
    $options = NestedArray::mergeDeep($element['#url']->getOptions(), $element['#options']);
    $element['#markup'] = BaseLink::fromTextAndUrl($element['#title'], $element['#url']->setOptions($options))
      ->toString();
    return $element;
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
Link::preRenderLink public static function Pre-render callback: Renders a link into #markup.
Link::preRenderLinks public static function Pre-render callback: Collects child links into a single array.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
RenderElementBase::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript. 2
RenderElementBase::preRenderGroup public static function Adds members of this group as actual elements for rendering. 2
RenderElementBase::processAjaxForm public static function Form element processing handler for the #ajax form property. 3
RenderElementBase::processGroup public static function Arranges elements into groups. 2
RenderElementBase::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes 2
SystemCompactLink::getInfo public function Returns the element properties for this element. Overrides Link::getInfo
SystemCompactLink::preRenderCompactLink public static function Pre-render callback: Renders a link into #markup.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.