You are here

Home » API reference » Language Selection Page 8.2 » LanguageSelectionPageConditionBase.php

abstract class LanguageSelectionPageConditionBase in Language Selection Page 8.2

Base class for language selection page condition.

Hierarchy

Expanded class hierarchy of LanguageSelectionPageConditionBase

11 files declare their use of LanguageSelectionPageConditionBase
LanguageSelectionPageConditionBlacklistedPaths.php in src/Plugin/LanguageSelectionPageCondition/LanguageSelectionPageConditionBlacklistedPaths.php
LanguageSelectionPageConditionIgnoreNeutral.php in src/Plugin/LanguageSelectionPageCondition/LanguageSelectionPageConditionIgnoreNeutral.php
LanguageSelectionPageConditionIndexPhp.php in src/Plugin/LanguageSelectionPageCondition/LanguageSelectionPageConditionIndexPhp.php
LanguageSelectionPageConditionLanguagePrefixes.php in src/Plugin/LanguageSelectionPageCondition/LanguageSelectionPageConditionLanguagePrefixes.php
LanguageSelectionPageConditionMethodIsValid.php in src/Plugin/LanguageSelectionPageCondition/LanguageSelectionPageConditionMethodIsValid.php

... See full list

File

src/LanguageSelectionPageConditionBase.php, line 15

Namespace

Drupal\language_selection_page
View source 
abstract class LanguageSelectionPageConditionBase extends ConditionPluginBase implements ConditionInterface, ContainerFactoryPluginInterface, LanguageSelectionPageConditionInterface {

  /**
   * The condition's weight, order of execution.
   *
   * @var int
   */
  protected $weight = 0;

  /**
   * {@inheritdoc}
   */
  public function alterPageContent(array &$content = [], $destination = '<front>') {
  }

  /**
   * {@inheritdoc}
   */
  public function alterPageResponse(&$content = []) {
  }

  /**
   * {@inheritdoc}
   */
  public function block() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function evaluate() {
    return $this
      ->execute();
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    $definition = $this
      ->getPluginDefinition();
    return !empty($definition['description']) ? $definition['description'] : NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function getDestination($destination) {
    return $destination;
  }

  /**
   * {@inheritdoc}
   */
  public function getName() {
    $definition = $this
      ->getPluginDefinition();
    return !empty($definition['name']) ? $definition['name'] : $this
      ->getPluginId();
  }

  /**
   * {@inheritdoc}
   */
  public function getWeight() {
    return !empty($this->weight) ? $this->weight : 0;
  }

  /**
   * {@inheritdoc}
   */
  public function pass() {
    return TRUE;
  }

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

  /**
   * {@inheritdoc}
   */
  public function setWeight($weight) {
    $this->weight = $weight;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration[$this
      ->getPluginId()] = $form_state
      ->getValue($this
      ->getPluginId());
  }

  /**
   * {@inheritdoc}
   */
  public function summary() {

    // This should return a summary but it's not used in our case.
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConditionPluginBase::$executableManager protected property The condition manager to proxy execute calls through.
ConditionPluginBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 5
ConditionPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ConditionPluginBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 5
ConditionPluginBase::execute public function Executes the plugin. Overrides ExecutableInterface::execute
ConditionPluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConditionPluginBase::isNegated public function Determines whether condition result will be negated. Overrides ConditionInterface::isNegated
ConditionPluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ConditionPluginBase::setExecutableManager public function Sets the executable manager class. Overrides ConditionInterface::setExecutableManager
ConditionPluginBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ConditionPluginBase::__construct public function Overrides \Drupal\Component\Plugin\PluginBase::__construct(). Overrides ContextAwarePluginBase::__construct 4
ContainerFactoryPluginInterface::create public static function Creates an instance of the plugin. 112
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginAssignmentTrait::t abstract protected function Ensures the t() method is available.
ContextAwarePluginBase::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated private property Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration protected function Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts 9
ContextAwarePluginBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge 7
ContextAwarePluginBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags 4
ContextAwarePluginBase::getContext public function This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition public function Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions public function Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping public function Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts public function Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues public function Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext public function Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping public function Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue public function Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts public function Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get public function Implements magic __get() method.
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
ExecutablePluginBase::getConfig public function Gets all configuration values.
ExecutablePluginBase::getConfigDefinition public function Gets the definition of a configuration option.
ExecutablePluginBase::getConfigDefinitions public function Gets an array of definitions of available configuration options.
ExecutablePluginBase::setConfig public function Sets the value of a particular configuration option.
LanguageSelectionPageConditionBase::$weight protected property The condition's weight, order of execution.
LanguageSelectionPageConditionBase::alterPageContent public function Alter the $content render array used to build the LSP page. Overrides LanguageSelectionPageConditionInterface::alterPageContent 2
LanguageSelectionPageConditionBase::alterPageResponse public function Alter the page response. Overrides LanguageSelectionPageConditionInterface::alterPageResponse
LanguageSelectionPageConditionBase::block public function Wrapper function that returns FALSE. Overrides LanguageSelectionPageConditionInterface::block
LanguageSelectionPageConditionBase::evaluate public function Evaluates the condition and returns TRUE or FALSE accordingly. Overrides ConditionInterface::evaluate 11
LanguageSelectionPageConditionBase::getDescription public function Returns the description of the plugin. Overrides LanguageSelectionPageConditionInterface::getDescription
LanguageSelectionPageConditionBase::getDestination public function Find the destination to redirect the user to after choosing the language. Overrides LanguageSelectionPageConditionInterface::getDestination 1
LanguageSelectionPageConditionBase::getName public function Returns the name of the plugin. Overrides LanguageSelectionPageConditionInterface::getName
LanguageSelectionPageConditionBase::getWeight public function Returns the weight of the plugin. Overrides LanguageSelectionPageConditionInterface::getWeight
LanguageSelectionPageConditionBase::pass public function Wrapper function that returns FALSE. Overrides LanguageSelectionPageConditionInterface::pass
LanguageSelectionPageConditionBase::postConfigSave public function Post config save method. Overrides LanguageSelectionPageConditionInterface::postConfigSave 1
LanguageSelectionPageConditionBase::setWeight public function Set the weight of the plugin. Overrides LanguageSelectionPageConditionInterface::setWeight
LanguageSelectionPageConditionBase::submitConfigurationForm public function Form submission handler. Overrides ConditionPluginBase::submitConfigurationForm 1
LanguageSelectionPageConditionBase::summary public function Provides a human readable summary of the condition's configuration. Overrides ConditionInterface::summary
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.
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
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2