Drupal 8  8.0.2
SystemCompactLink Class Reference
Inheritance diagram for SystemCompactLink:

Public Member Functions

 getInfo ()
 
- Public Member Functions inherited from PluginInspectionInterface
 getPluginId ()
 
 getPluginDefinition ()
 

Static Public Member Functions

static preRenderCompactLink ($element)
 
- Static Public Member Functions inherited from RenderElement
static setAttributes (&$element, $class=array())
 
static preRenderGroup ($element)
 
static processAjaxForm (&$element, FormStateInterface $form_state, &$complete_form)
 
static preRenderAjaxForm ($element)
 
static processGroup (&$element, FormStateInterface $form_state, &$complete_form)
 

Detailed Description

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

Usage example:

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

("system_compact_link")

Member Function Documentation

getInfo ( )

{Returns the element properties for this element.

Returns
array An array of element properties. See ::getInfo() for documentation of the standard properties of all elements, and the return value format.
}

Implements ElementInterface.

static preRenderCompactLink (   $element)
static

Pre-render callback: Renders a link into #markup.

Doing so during pre_render gives modules a chance to alter the link parts.

Parameters
array$elementA 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.
Returns
array The passed-in element containing the system compact link default values.

References Drupal\destination(), Drupal\l(), NestedArray\mergeDeep(), and t().

Here is the call graph for this function:


The documentation for this class was generated from the following file: