class KeySelect in Key 8

Provides a select form element that displays available keys.

Properties:

• #empty_option: The label that will be displayed to denote no selection.
• #empty_value: The value of the option that is used to denote no selection.
• #key_filters: An array of filters to apply to the list of keys.
• #key_description: A boolean value that determines if information about keys is added to the element's description.

Plugin annotation

@FormElement("key_select");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
        • class \Drupal\Core\Render\Element\Select
          • class \Drupal\key\Element\KeySelect

1 #type use of KeySelect

KeyConfigOverrideAddForm::buildForm in src/Form/KeyConfigOverrideAddForm.php

Form constructor.

File

src/Element/KeySelect.php, line 21

Namespace

Drupal\key\Element

class KeySelect extends Select {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $info = parent::getInfo();
    $class = get_class($this);

    // Add a process function.
    array_unshift($info['#process'], [
      $class,
      'processKeySelect',
    ]);

    // Add a property for key filters.
    $info['#key_filters'] = [];

    // Add a property for key description.
    $info['#key_description'] = TRUE;
    return $info;
  }

  /**
   * Processes a key select list form element.
   *
   * @param array $element
   *   The form element to process.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param array $complete_form
   *   The complete form structure.
   *
   * @return array
   *   The processed element.
   */
  public static function processKeySelect(array &$element, FormStateInterface $form_state, array &$complete_form) {

    // Get the list of available keys and define the options.
    $options = \Drupal::service('key.repository')
      ->getKeyNamesAsOptions($element['#key_filters']);
    $element['#options'] = $options;

    // Prefix the default description with information about keys,
    // unless disabled.
    if ($element['#key_description']) {
      $original_description = isset($element['#description']) ? $element['#description'] : '';

      // @todo this causes escaping.
      $key_description = t('Choose an available key. If the desired key is not listed, <a href=":link">create a new key</a>.', [
        ':link' => Url::fromRoute('entity.key.add_form')
          ->toString(),
      ]);
      $element['#description'] = $key_description . ' ' . $original_description;
    }
    return $element;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormElement::processAutocomplete	public static	function	Adds autocomplete functionality to elements.
FormElement::processPattern	public static	function	#process callback for #pattern form element property.
FormElement::validatePattern	public static	function	#element_validate callback for #pattern form element property.
KeySelect::getInfo	public	function	Returns the element properties for this element. Overrides Select::getInfo
KeySelect::processKeySelect	public static	function	Processes a key select list form element.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.	1
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute. Overrides ElementInterface::setAttributes
Select::preRenderSelect	public static	function	Prepares a select render element.
Select::processSelect	public static	function	Processes a select list form element.
Select::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.