abstract class KeyFormBase in Key 8

Base form for key add and edit forms.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
  - class \Drupal\key\Form\KeyFormBase

Expanded class hierarchy of KeyFormBase

File

src/Form/KeyFormBase.php, line 16

Namespace

Drupal\key\Form

View source

abstract class KeyFormBase extends EntityForm {

  /**
   * The key storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $storage;

  /**
   * The original key.
   *
   * @var \Drupal\key\Entity\Key|null
   *   The original key entity or NULL if this is a new key.
   */
  protected $originalKey = NULL;

  /**
   * Constructs a new key form base.
   *
   * @param \Drupal\Core\Config\Entity\ConfigEntityStorageInterface $storage
   *   The key storage.
   */
  public function __construct(ConfigEntityStorageInterface $storage) {
    $this->storage = $storage;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager')
      ->getStorage('key'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // If the form is rebuilding.
    if ($form_state
      ->isRebuilding()) {

      // If a key type change triggered the rebuild.
      if ($form_state
        ->getTriggeringElement()['#name'] == 'key_type') {

        // Update the type and input plugins.
        $this
          ->updateKeyType($form_state);
        $this
          ->updateKeyInput($form_state);
      }

      // If a key provider change triggered the rebuild.
      if ($form_state
        ->getTriggeringElement()['#name'] == 'key_provider') {

        // Update the provider and input plugins.
        $this
          ->updateKeyProvider($form_state);
        $this
          ->updateKeyInput($form_state);
      }
    }
    else {

      // Update the input plugin.
      $this
        ->updateKeyInput($form_state);
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {

    /* @var $key \Drupal\key\Entity\Key */
    $key = $this->entity;
    $form['label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Key name'),
      '#maxlength' => 255,
      '#default_value' => $key
        ->label(),
      '#required' => TRUE,
    ];
    $form['id'] = [
      '#type' => 'machine_name',
      '#default_value' => $key
        ->id(),
      '#machine_name' => [
        'exists' => [
          $this->storage,
          'load',
        ],
      ],
      '#disabled' => !$key
        ->isNew(),
    ];
    $form['description'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Description'),
      '#default_value' => $key
        ->getDescription(),
      '#description' => $this
        ->t('A short description of the key.'),
    ];

    // This is the element that contains all of the dynamic parts of the form.
    $form['settings'] = [
      '#type' => 'container',
      '#prefix' => '<div id="key-settings">',
      '#suffix' => '</div>',
    ];

    // Key type section.
    $form['settings']['type_section'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Type settings'),
      '#open' => TRUE,
    ];
    $form['settings']['type_section']['key_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Key type'),
      '#options' => $key
        ->getPluginsAsOptions('key_type'),
      '#required' => TRUE,
      '#default_value' => $key
        ->getKeyType()
        ->getPluginId(),
      '#ajax' => [
        'callback' => [
          $this,
          'ajaxUpdateSettings',
        ],
        'event' => 'change',
        'wrapper' => 'key-settings',
      ],
    ];
    $form['settings']['type_section']['key_type_description'] = [
      '#markup' => $key
        ->getKeyType()
        ->getPluginDefinition()['description'],
    ];
    $form['settings']['type_section']['key_type_settings'] = [
      '#type' => 'container',
      '#title' => $this
        ->t('Key type settings'),
      '#title_display' => FALSE,
      '#tree' => TRUE,
    ];
    if ($key
      ->getKeyType() instanceof KeyPluginFormInterface) {
      $plugin_form_state = $this
        ->createPluginFormState('key_type', $form_state);
      $form['settings']['type_section']['key_type_settings'] += $key
        ->getKeyType()
        ->buildConfigurationForm([], $plugin_form_state);
      $form_state
        ->setValue('key_type_settings', $plugin_form_state
        ->getValues());
    }

    // Key provider section.
    $form['settings']['provider_section'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Provider settings'),
      '#open' => TRUE,
    ];
    $form['settings']['provider_section']['key_provider'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Key provider'),
      '#options' => $key
        ->getPluginsAsOptions('key_provider'),
      '#required' => TRUE,
      '#default_value' => $key
        ->getKeyProvider()
        ->getPluginId(),
      '#ajax' => [
        'callback' => [
          $this,
          'ajaxUpdateSettings',
        ],
        'event' => 'change',
        'wrapper' => 'key-settings',
      ],
    ];
    $form['settings']['provider_section']['key_provider_description'] = [
      '#markup' => $key
        ->getKeyProvider()
        ->getPluginDefinition()['description'],
    ];
    $form['settings']['provider_section']['key_provider_settings'] = [
      '#type' => 'container',
      '#title' => $this
        ->t('Key provider settings'),
      '#title_display' => FALSE,
      '#tree' => TRUE,
    ];
    if ($key
      ->getKeyProvider() instanceof KeyPluginFormInterface) {
      $plugin_form_state = $this
        ->createPluginFormState('key_provider', $form_state);
      $form['settings']['provider_section']['key_provider_settings'] += $key
        ->getKeyProvider()
        ->buildConfigurationForm([], $plugin_form_state);
      $form_state
        ->setValue('key_provider_settings', $plugin_form_state
        ->getValues());
    }

    // Key input section.
    $form['settings']['input_section'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Value'),
      '#open' => TRUE,
    ];
    $form['settings']['input_section']['key_input'] = [
      '#type' => 'value',
      '#value' => $key
        ->getKeyInput()
        ->getPluginId(),
    ];
    $form['settings']['input_section']['key_input_settings'] = [
      '#type' => 'container',
      '#title' => $this
        ->t('Key value settings'),
      '#title_display' => FALSE,
      '#tree' => TRUE,
    ];
    if ($key
      ->getKeyInput() instanceof KeyPluginFormInterface) {
      $plugin_form_state = $this
        ->createPluginFormState('key_input', $form_state);
      $form['settings']['input_section']['key_input_settings'] += $key
        ->getKeyInput()
        ->buildConfigurationForm([], $plugin_form_state);
      $form_state
        ->setValue('key_input_settings', $plugin_form_state
        ->getValues());
    }
    return parent::form($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    if (!$form_state
      ->isSubmitted()) {
      return;
    }

    // Make sure each plugin settings field is an array.
    foreach ($this->entity
      ->getPluginTypes() as $type) {
      if (!$form_state
        ->getValue($type . '_settings')) {
        $form_state
          ->setValue($type . '_settings', []);
      }
    }
    $processed_values = [
      'submitted' => NULL,
      'processed_submitted' => NULL,
    ];
    foreach ($this->entity
      ->getPlugins() as $type => $plugin) {
      if ($plugin instanceof KeyPluginFormInterface) {
        $plugin_form_state = $this
          ->createPluginFormState($type, $form_state);

        // Special behavior for the Key Input plugin.
        if ($type == 'key_input') {

          // If the provider accepts a key value.
          if ($this->entity
            ->getKeyProvider()
            ->getPluginDefinition()['key_value']['accepted']) {
            $processed_values = $plugin
              ->processSubmittedKeyValue($plugin_form_state);
          }
        }
        $plugin
          ->validateConfigurationForm($form, $plugin_form_state);
        $form_state
          ->setValue($type . '_settings', $plugin_form_state
          ->getValues());
        $this
          ->moveFormStateErrors($plugin_form_state, $form_state);
        $this
          ->moveFormStateStorage($plugin_form_state, $form_state);
      }
    }

    // Store the submitted and processed key values in form state.
    $key_value_data = $form_state
      ->get('key_value');
    $key_value_data['submitted'] = $processed_values['submitted'];
    $key_value_data['processed_submitted'] = $processed_values['processed_submitted'];
    $form_state
      ->set('key_value', $key_value_data);

    // Allow the Key Type plugin to validate the key value. Use the processed
    // key value if there is one. Otherwise, retrieve the key value using the
    // key provider.
    if (isset($processed_values['processed_submitted'])) {
      $key_value = $processed_values['processed_submitted'];
    }
    else {

      // Create a temporary key entity to retrieve the key value.
      $temp_key = new Key($form_state
        ->getValues(), 'key');
      $key_value = $temp_key
        ->getKeyValue(TRUE);
    }
    $plugin_form_state = $this
      ->createPluginFormState('key_type', $form_state);
    $this->entity
      ->getKeyType()
      ->validateKeyValue($form, $plugin_form_state, $key_value);
    $form_state
      ->setValue('key_type_settings', $plugin_form_state
      ->getValues());
    $this
      ->moveFormStateErrors($plugin_form_state, $form_state);
    $this
      ->moveFormStateStorage($plugin_form_state, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $key_value_data = $form_state
      ->get('key_value');
    foreach ($this->entity
      ->getPlugins() as $type => $plugin) {
      if ($plugin instanceof KeyPluginFormInterface) {
        $plugin_form_state = $this
          ->createPluginFormState($type, $form_state);
        $plugin
          ->submitConfigurationForm($form, $plugin_form_state);
        $form_state
          ->setValue($type . '_settings', $plugin_form_state
          ->getValues());
      }
    }

    // If the key provider allows a key value to be set.
    if ($this->entity
      ->getKeyProvider() instanceof KeyProviderSettableValueInterface) {
      $set_key_value = FALSE;

      // If the key provider has changed, the key value should be set.
      if ($this->originalKey && $this->originalKey
        ->getKeyProvider()
        ->getPluginId() != $this->entity
        ->getKeyProvider()
        ->getPluginId()) {
        $set_key_value = TRUE;
      }

      // If the submitted value is not the same as the obscured value,
      // the key value should be set.
      if ($key_value_data['submitted'] != $key_value_data['obscured']) {
        $set_key_value = TRUE;
      }

      // If the processed value is not empty, but the submitted value is,
      // the key value should be set.
      if (!empty($key_value_data['processed_original']) && empty($key_value_data['submitted'])) {
        $set_key_value = TRUE;
      }

      // Set the key value in the entity, if necessary.
      if ($set_key_value) {
        $this->entity
          ->setKeyValue($key_value_data['processed_submitted']);
      }
    }
    parent::submitForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function save(array $form, FormStateInterface $form_state) {

    // Allow exceptions to percolate, per EntityFormInterface.
    $status = parent::save($form, $form_state);
    $t_args = [
      '%name' => $this->entity
        ->label(),
    ];
    if ($status == SAVED_UPDATED) {
      $this
        ->messenger()
        ->addStatus($this
        ->t('The key %name has been updated.', $t_args));
    }
    elseif ($status == SAVED_NEW) {
      $this
        ->messenger()
        ->addStatus($this
        ->t('The key %name has been added.', $t_args));
    }
    $form_state
      ->setRedirectUrl($this->entity
      ->toUrl('collection'));
    return $status;
  }

  /**
   * AJAX callback to update the dynamic settings on the form.
   *
   * @param array $form
   *   The form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   *
   * @return array
   *   The element to update in the form.
   */
  public function ajaxUpdateSettings(array &$form, FormStateInterface $form_state) {
    return $form['settings'];
  }

  /**
   * Update the Key Type plugin.
   */
  protected function updateKeyType(FormStateInterface $form_state) {

    /* @var $key \Drupal\key\Entity\Key */
    $key = $this->entity;

    /* @var $plugin \Drupal\key\Plugin\KeyPluginInterface */
    $plugin = $key
      ->getKeyType();
    $key
      ->setPlugin('key_type', $plugin
      ->getPluginId());

    // If an original key exists and the plugin ID matches the existing one.
    if ($this->originalKey && $this->originalKey
      ->getKeyType()
      ->getPluginId() == $plugin
      ->getPluginId()) {

      // Use the configuration from the original key's plugin.
      $configuration = $this->originalKey
        ->getKeyType()
        ->getConfiguration();
    }
    else {

      // Use the plugin's default configuration.
      $configuration = $plugin
        ->defaultConfiguration();
    }
    $plugin
      ->setConfiguration($configuration);
    $form_state
      ->setValue('key_type_settings', []);
    $form_state
      ->getUserInput()['key_type_settings'] = [];
  }

  /**
   * Update the Key Provider plugin.
   */
  protected function updateKeyProvider(FormStateInterface $form_state) {

    /* @var $key \Drupal\key\Entity\Key */
    $key = $this->entity;

    /* @var $plugin \Drupal\key\Plugin\KeyPluginInterface */
    $plugin = $key
      ->getKeyProvider();
    $key
      ->setPlugin('key_provider', $plugin
      ->getPluginId());

    // If an original key exists and the plugin ID matches the existing one.
    if ($this->originalKey && $this->originalKey
      ->getKeyProvider()
      ->getPluginId() == $plugin
      ->getPluginId()) {

      // Use the configuration from the original key's plugin.
      $configuration = $this->originalKey
        ->getKeyProvider()
        ->getConfiguration();
    }
    else {

      // Use the plugin's default configuration.
      $configuration = $plugin
        ->defaultConfiguration();
    }
    $plugin
      ->setConfiguration($configuration);
    $form_state
      ->setValue('key_provider_settings', []);
    $form_state
      ->getUserInput()['key_provider_settings'] = [];
  }

  /**
   * Update the Key Input plugin.
   *
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   */
  protected function updateKeyInput(FormStateInterface $form_state) {

    /* @var $key \Drupal\key\Entity\Key */
    $key = $this->entity;

    /* @var $plugin \Drupal\key\Plugin\KeyPluginInterface */
    $plugin = $key
      ->getKeyInput();

    // Get the current key value data.
    $key_value_data = $form_state
      ->get('key_value');

    // Determine which Key Input plugin should be used.
    $key_input_id = 'none';
    if ($key
      ->getKeyProvider()
      ->getPluginDefinition()['key_value']['accepted']) {
      $key_input_id = $key
        ->getKeyType()
        ->getPluginDefinition()['key_value']['plugin'];
    }

    // Set the Key Input plugin.
    $key
      ->setPlugin('key_input', $key_input_id);

    // Set the plugin's configuration to the default. It may be
    // overridden below.
    $configuration = $plugin
      ->defaultConfiguration();

    // Clear the current key value. It may be overridden below.
    $key_value_data['current'] = '';
    $use_original_key_value = FALSE;

    // If an original key exists, one of the following conditions must
    // be met in order to use the key value from it:
    // - The key value was not obscured when the form first loaded
    // - The original key provider is the same as the current one
    //   AND the original key type is the same as the current one.
    if ($this->originalKey) {

      // If the key value is not obscured.
      if (empty($key_value_data['obscured'])) {
        $use_original_key_value = TRUE;
      }

      // If the original key provider is the same as the current one.
      if ($this->originalKey
        ->getKeyProvider()
        ->getPluginId() == $key
        ->getKeyProvider()
        ->getPluginId()) {

        // If the original key type is the same as the current one.
        if ($this->originalKey
          ->getKeyType()
          ->getPluginId() == $key
          ->getKeyType()
          ->getPluginId()) {
          $use_original_key_value = TRUE;
        }
      }
    }

    // If the original key value can be used.
    if ($use_original_key_value) {

      // Use the configuration from the original key's plugin.
      $configuration = $this->originalKey
        ->getKeyInput()
        ->getConfiguration();

      // Set the current key value.
      $key_value_data['current'] = !empty($key_value_data['obscured']) ? $key_value_data['obscured'] : $key_value_data['processed_original'];
    }
    $plugin
      ->setConfiguration($configuration);
    $form_state
      ->setValue('key_input_settings', []);
    $form_state
      ->getUserInput()['key_input_settings'] = [];
    $form_state
      ->set('key_value', $key_value_data);
  }

  /**
   * Returns the original key entity.
   *
   * @return \Drupal\key\Entity\Key
   *   The original key entity.
   */
  public function getOriginalKey() {
    return $this->originalKey;
  }

  /**
   * Creates a FormStateInterface object for a plugin.
   *
   * @param string $type
   *   The plugin type ID.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state to copy values from.
   *
   * @return \Drupal\Core\Form\FormStateInterface
   *   A clone of the form state object with values from the plugin.
   */
  protected function createPluginFormState($type, FormStateInterface $form_state) {

    // Clone the form state.
    $plugin_form_state = clone $form_state;

    // Clear the values, except for this plugin type's settings.
    $plugin_form_state
      ->setValues($form_state
      ->getValue($type . '_settings', []));
    return $plugin_form_state;
  }

  /**
   * Moves form errors from one form state to another.
   *
   * @param \Drupal\Core\Form\FormStateInterface $from
   *   The form state object to move from.
   * @param \Drupal\Core\Form\FormStateInterface $to
   *   The form state object to move to.
   */
  protected function moveFormStateErrors(FormStateInterface $from, FormStateInterface $to) {
    foreach ($from
      ->getErrors() as $name => $error) {
      $to
        ->setErrorByName($name, $error);
    }
  }

  /**
   * Moves storage variables from one form state to another.
   *
   * @param \Drupal\Core\Form\FormStateInterface $from
   *   The form state object to move from.
   * @param \Drupal\Core\Form\FormStateInterface $to
   *   The form state object to move to.
   */
  protected function moveFormStateStorage(FormStateInterface $from, FormStateInterface $to) {
    foreach ($from
      ->getStorage() as $index => $value) {
      $to
        ->set($index, $value);
    }
  }

}

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
EntityForm::$entity	protected	property	The entity being used by this form.	7
EntityForm::$entityTypeManager	protected	property	The entity type manager.	3
EntityForm::$moduleHandler	protected	property	The module handler service.
EntityForm::$operation	protected	property	The name of the current operation.
EntityForm::$privateEntityManager	private	property	The entity manager.
EntityForm::actions	protected	function	Returns an array of supported actions for the current entity form.	29
EntityForm::actionsElement	protected	function	Returns the action form element for the current entity form.
EntityForm::afterBuild	public	function	Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildEntity	public	function	Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity	2
EntityForm::copyFormValuesToEntity	protected	function	Copies top-level form values to entity properties	7
EntityForm::getBaseFormId	public	function	Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId	5
EntityForm::getEntity	public	function	Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::getEntityFromRouteMatch	public	function	Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch	1
EntityForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId	10
EntityForm::getOperation	public	function	Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::init	protected	function	Initialize the form state and the entity before the first form build.	3
EntityForm::prepareEntity	protected	function	Prepares the entity object before the form is built first.	3
EntityForm::prepareInvokeAll	protected	function	Invokes the specified prepare hook variant.
EntityForm::processForm	public	function	Process callback: assigns weights and hides extra fields.
EntityForm::setEntity	public	function	Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityManager	public	function	Sets the entity manager for this form. Overrides EntityFormInterface::setEntityManager
EntityForm::setEntityTypeManager	public	function	Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler	public	function	Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation	public	function	Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::__get	public	function
EntityForm::__set	public	function
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
KeyFormBase::$originalKey	protected	property	The original key.
KeyFormBase::$storage	protected	property	The key storage.
KeyFormBase::ajaxUpdateSettings	public	function	AJAX callback to update the dynamic settings on the form.
KeyFormBase::buildForm	public	function	Form constructor. Overrides EntityForm::buildForm	2
KeyFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
KeyFormBase::createPluginFormState	protected	function	Creates a FormStateInterface object for a plugin.
KeyFormBase::form	public	function	Gets the actual form array to be built. Overrides EntityForm::form	1
KeyFormBase::getOriginalKey	public	function	Returns the original key entity.
KeyFormBase::moveFormStateErrors	protected	function	Moves form errors from one form state to another.
KeyFormBase::moveFormStateStorage	protected	function	Moves storage variables from one form state to another.
KeyFormBase::save	public	function	Form submission handler for the 'save' action. Overrides EntityForm::save
KeyFormBase::submitForm	public	function	This is the default entity object builder function. It is called before any other submit handler to build the new entity object to be used by the following submit handlers. At this point of the form workflow the entity is validated and the form state… Overrides EntityForm::submitForm
KeyFormBase::updateKeyInput	protected	function	Update the Key Input plugin.
KeyFormBase::updateKeyProvider	protected	function	Update the Key Provider plugin.
KeyFormBase::updateKeyType	protected	function	Update the Key Type plugin.
KeyFormBase::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm	1
KeyFormBase::__construct	public	function	Constructs a new key form base.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

abstract class KeyFormBase in Key 8

Hierarchy

File

Namespace

Members

API Navigation