abstract class EdgeEntityAliasConfigFormBase in Apigee Edge 8

Base form for those Apigee Edge entities that supports aliasing.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\apigee_edge\Form\EdgeEntityAliasConfigFormBase

Expanded class hierarchy of EdgeEntityAliasConfigFormBase

2 files declare their use of EdgeEntityAliasConfigFormBase

TeamAliasForm.php in modules/apigee_edge_teams/src/Form/TeamAliasForm.php
TeamAppAliasForm.php in modules/apigee_edge_teams/src/Form/TeamAppAliasForm.php

File

src/Form/EdgeEntityAliasConfigFormBase.php, line 29

Namespace

Drupal\apigee_edge\Form

View source

abstract class EdgeEntityAliasConfigFormBase extends ConfigFormBase {

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config($this
      ->getConfigNameWithLabels());
    $form['label'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('How to refer to a @entity_type on the UI', [
        '@entity_type' => $this
          ->entityTypeName(),
      ]),
      '#collapsible' => FALSE,
    ];
    $form['label']['entity_label_singular'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Singular format'),
      '#default_value' => $config
        ->get('entity_label_singular'),
      '#description' => $this
        ->t('Leave empty to use the default "@singular_label" label.', [
        '@singular_label' => $this
          ->originalSingularLabel(),
      ]),
    ];
    $form['label']['entity_label_plural'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Plural format'),
      '#default_value' => $config
        ->get('entity_label_plural'),
      '#description' => $this
        ->t('Leave empty to use the default "@plural_label" label.', [
        '@plural_label' => $this
          ->originalPluralLabel(),
      ]),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config($this
      ->getConfigNameWithLabels());
    if ($config
      ->get('entity_label_singular') !== $form_state
      ->getValue('entity_label_singular') || $config
      ->get('entity_label_plural') !== $form_state
      ->getValue('entity_label_plural')) {
      $config
        ->set('entity_label_singular', $form_state
        ->getValue('entity_label_singular'))
        ->set('entity_label_plural', $form_state
        ->getValue('entity_label_plural'))
        ->save();

      // An entity label could be cached in multiple places so let's clear
      // all caches.
      drupal_flush_all_caches();
    }
    parent::submitForm($form, $form_state);
  }

  /**
   * Returns the name of the config that contains the entity labels.
   *
   * @return string
   *   The name of the config.
   */
  protected function getConfigNameWithLabels() : string {
    $configs = $this
      ->getEditableConfigNames();
    return reset($configs);
  }

  /**
   * Returns the human readable name of the entity.
   *
   * @return string
   *   The name of the entity.
   */
  protected abstract function entityTypeName() : string;

  /**
   * Returns the original singular label of the entity.
   *
   * This information can not be retrieved directly from entity annotation
   * at this moment.
   *
   * @return string
   *   The singular label.
   */
  protected abstract function originalSingularLabel() : string;

  /**
   * Returns the original plural label of the entity.
   *
   * This information can not be retrieved directly from entity annotation
   * at this moment.
   *
   * @return string
   *   The plural label.
   */
  protected abstract function originalPluralLabel() : string;

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create	13
ConfigFormBase::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object.	11
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
ConfigFormBaseTrait::getEditableConfigNames	abstract protected	function	Gets the configuration names that will be editable.	32
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
EdgeEntityAliasConfigFormBase::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
EdgeEntityAliasConfigFormBase::entityTypeName	abstract protected	function	Returns the human readable name of the entity.	4
EdgeEntityAliasConfigFormBase::getConfigNameWithLabels	protected	function	Returns the name of the config that contains the entity labels.
EdgeEntityAliasConfigFormBase::originalPluralLabel	abstract protected	function	Returns the original plural label of the entity.	4
EdgeEntityAliasConfigFormBase::originalSingularLabel	abstract protected	function	Returns the original singular label of the entity.	4
EdgeEntityAliasConfigFormBase::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
FormInterface::getFormId	public	function	Returns a unique string identifying the form.	236
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 EdgeEntityAliasConfigFormBase in Apigee Edge 8

Hierarchy

File

Namespace

Members

API Navigation