abstract class EdgeEntityCacheConfigFormBase in Apigee Edge 8

Base cache expiration config form for Apigee Edge entities.

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\EdgeEntityCacheConfigFormBase

2 files declare their use of EdgeEntityCacheConfigFormBase

TeamAppCacheForm.php in modules/apigee_edge_teams/src/Form/TeamAppCacheForm.php

TeamCacheForm.php in modules/apigee_edge_teams/src/Form/TeamCacheForm.php

File

src/Form/EdgeEntityCacheConfigFormBase.php, line 30

Namespace

Drupal\apigee_edge\Form

abstract class EdgeEntityCacheConfigFormBase extends ConfigFormBase {

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config($this
      ->getConfigNameWithCacheSettings());
    $form['cache'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Caching'),
      '#collapsible' => FALSE,
    ];
    $form['cache']['cache_expiration'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Expires'),
      '#description' => $this
        ->t('Number of <strong>seconds</strong> until a cached item expires. Use <em>-1</em> to cache items until they have been updated on the Developer Portal (ignore changes made on the Apigee Edge Management UI or in an external application). Use <em>0</em> to completely disable caching.'),
      '#default_value' => $config
        ->get('cache_expiration'),
      '#min' => -1,
      '#required' => TRUE,
    ];
    $form['cache']['actions'] = [
      '#type' => 'actions',
    ];
    $form['cache']['actions']['invalidate_cache'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Invalidate cache'),
      '#limit_validation_errors' => [],
      '#submit' => [
        '::invalidateCache',
      ],
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config($this
      ->getConfigNameWithCacheSettings())
      ->set('cache_expiration', $form_state
      ->getValue('cache_expiration'))
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * Submit handler that invalidates stored cache items from of an entity type.
   *
   * @param array $form
   *   Form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form state object.
   */
  public function invalidateCache(array $form, FormStateInterface $form_state) {
    Cache::invalidateTags([
      $this
        ->getEntityType(),
    ]);
  }

  /**
   * Returns the name of the config object that contains "cache_expiration" key.
   *
   * @return string
   *   The if of a configuration object.
   */
  protected function getConfigNameWithCacheSettings() : string {
    $configs = $this
      ->getEditableConfigNames();
    return reset($configs);
  }

  /**
   * Name of the entity type that cache expiration is controlled here.
   *
   * @return string
   *   The id of an entity type.
   */
  protected abstract function getEntityType() : 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
EdgeEntityCacheConfigFormBase::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
EdgeEntityCacheConfigFormBase::getConfigNameWithCacheSettings	protected	function	Returns the name of the config object that contains "cache_expiration" key.
EdgeEntityCacheConfigFormBase::getEntityType	abstract protected	function	Name of the entity type that cache expiration is controlled here.	5
EdgeEntityCacheConfigFormBase::invalidateCache	public	function	Submit handler that invalidates stored cache items from of an entity type.
EdgeEntityCacheConfigFormBase::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.