You are here

Home » API reference » GoogleTagManager 8 » ConditionBase.php

abstract class ConditionBase in GoogleTagManager 8

Provides a basis for fulfilling contexts for condition plugins.

Hierarchy

Expanded class hierarchy of ConditionBase

See also

\Drupal\Core\Condition\Annotation\Condition

\Drupal\Core\Condition\ConditionInterface

\Drupal\Core\Condition\ConditionManager

2 files declare their use of ConditionBase
Domain.php in src/Plugin/Condition/Domain.php
Language.php in src/Plugin/Condition/Language.php

File

src/ConditionBase.php, line 21

Namespace

Drupal\google_tag
View source 
abstract class ConditionBase extends ExecutablePluginBase implements ConditionInterface {
  use ContextAwarePluginAssignmentTrait;

  /**
   * The condition manager to proxy execute calls through.
   *
   * @var \Drupal\Core\Executable\ExecutableManagerInterface
   */
  protected $executableManager;

  /**
   * The toggle element name.
   *
   * @var string
   */
  protected $toggle;

  /**
   * The list element name.
   *
   * @var string
   */
  protected $list;

  /**
   * The singular form of condition type.
   *
   * @var string
   */
  protected $singular;

  /**
   * The plural form of condition type.
   *
   * @var string
   */
  protected $plural;

  /**
   * The options for the list element.
   *
   * @var array
   */
  protected $options = [];

  /**
   * The selected options (for the summary message).
   *
   * @var array
   */
  protected $values = [];

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this
      ->setConfiguration($configuration);
  }

  /**
   * {@inheritdoc}
   */
  public function getConfiguration() {
    return [
      'id' => $this
        ->getPluginId(),
    ] + $this->configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $this->configuration = $configuration + $this
      ->defaultConfiguration();
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function setExecutableManager(ExecutableManagerInterface $executableManager) {
    $this->executableManager = $executableManager;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      $this->toggle => GOOGLE_TAG_EXCLUDE_LISTED,
      $this->list => [],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function isNegated() {
    return $this->configuration[$this->toggle] == GOOGLE_TAG_EXCLUDE_LISTED;
  }

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

    // Gather data.
    if ($form_state instanceof SubformStateInterface) {
      $form_state = $form_state
        ->getCompleteFormState();
    }
    $contexts = $form_state
      ->getTemporaryValue('gathered_contexts') ?: [];

    // Build form elements.
    $form[$this->toggle] = [
      '#type' => 'radios',
      '#title' => $this
        ->specialT('Insert snippet for specific @plural'),
      '#options' => [
        GOOGLE_TAG_EXCLUDE_LISTED => $this
          ->specialT('All @plural except the selected @plural'),
        GOOGLE_TAG_INCLUDE_LISTED => $this
          ->specialT('Only the selected @plural'),
      ],
      '#default_value' => $this->configuration[$this->toggle],
    ];
    $form[$this->list] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->specialT('Selected @plural'),
      '#options' => $this->options,
      '#default_value' => $this->configuration[$this->list],
    ];
    $form['context_mapping'] = $this
      ->addContextAssignmentElement($this, $contexts);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this->configuration[$this->toggle] = $form_state
      ->getValue($this->toggle);
    $this->configuration[$this->list] = array_filter($form_state
      ->getValue($this->list));
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->hasValue('context_mapping')) {
      $this
        ->setContextMapping($form_state
        ->getValue('context_mapping'));
    }
  }

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

    // @todo Remove this routine? It does the quirky negate.
    return $this->executableManager
      ->execute($this);
  }

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

    // @todo Convert a string list of items to an array and reuse this code.
    $toggle = $this->configuration[$this->toggle];
    $values = $this->configuration[$this->list];
    if (empty($values)) {
      $satisfied = $this
        ->isNegated();
    }
    else {
      $satisfied = in_array($this
        ->contextToEvaluate(), $values);
      $satisfied = $this
        ->isNegated() ? !$satisfied : $satisfied;
    }
    return $satisfied;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function summary() {
    $string = 'The @singular is @adverb@verb "@list".';
    $args = [
      '@singular' => $this->singular,
      '@adverb' => $this
        ->isNegated() ? 'not ' : '',
      '@verb' => count($this->values) > 1 ? 'in' : '',
    ];
    return $this
      ->t(strtr($string, $args), [
      '@list' => implode(', ', $this->values),
    ]);
  }

  /**
   * Returns a TranslatableMarkup object after placeholder substitution.
   *
   * @param string $string
   *   The string to manipulate.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The markup object.
   */
  public function specialT($string) {
    return $this
      ->t(strtr($string, [
      '@plural' => $this->plural,
    ]));
  }

  /**
   * Returns the entity ID of the context value.
   *
   * @return string
   *   The entity ID of the context value.
   */
  public function contextToEvaluate() {
    return '';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConditionBase::$executableManager protected property The condition manager to proxy execute calls through.
ConditionBase::$list protected property The list element name.
ConditionBase::$options protected property The options for the list element.
ConditionBase::$plural protected property The plural form of condition type.
ConditionBase::$singular protected property The singular form of condition type.
ConditionBase::$toggle protected property The toggle element name.
ConditionBase::$values protected property The selected options (for the summary message).
ConditionBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 2
ConditionBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ConditionBase::contextToEvaluate public function Returns the entity ID of the context value. 2
ConditionBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
ConditionBase::evaluate public function Evaluates the condition and returns TRUE or FALSE accordingly. Overrides ConditionInterface::evaluate
ConditionBase::execute public function Executes the plugin. Overrides ExecutableInterface::execute
ConditionBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConditionBase::isNegated public function Determines whether condition result will be negated. Overrides ConditionInterface::isNegated
ConditionBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ConditionBase::setExecutableManager public function Sets the executable manager class. Overrides ConditionInterface::setExecutableManager
ConditionBase::specialT public function Returns a TranslatableMarkup object after placeholder substitution.
ConditionBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
ConditionBase::summary public function Provides a human readable summary of the condition's configuration. Overrides ConditionInterface::summary 2
ConditionBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ConditionBase::__construct public function Overrides \Drupal\Component\Plugin\PluginBase::__construct(). Overrides ContextAwarePluginBase::__construct 2
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.
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