You are here

Home » API reference » Term condition 8 » Term.php

class Term in Term condition 8

Same name and namespace in other branches
  1. 2.0.x src/Plugin/Condition/Term.php \Drupal\term_condition\Plugin\Condition\Term

Provides a 'Term' condition to enable a condition based in module selected status.

Plugin annotation


@Condition(
  id = "term",
  label = @Translation("Term"),
  context = {
    "node" = @ContextDefinition("entity:node", required = FALSE , label = @Translation("node"))
  }
)

Hierarchy

Expanded class hierarchy of Term

File

src/Plugin/Condition/Term.php, line 30
Contains \Drupal\term_condition\Plugin\Condition\Term.

Namespace

Drupal\term_condition\Plugin\Condition
View source 
class Term extends ConditionPluginBase implements ContainerFactoryPluginInterface {

  /**
   *  Entity manager instance.
   *
   * @var EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Creates a new ExampleCondition instance.
   *
   * @param EntityTypeManagerInterface $entity_manager
   *   The entity storage.
   * @param array $configuration
   *   The plugin configuration, i.e. an array with configuration values keyed
   *   by configuration option name. The special key 'context' may be used to
   *   initialize the defined contexts by setting it to an array of context
   *   values keyed by context names.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   */
  public function __construct(EntityTypeManagerInterface $entity_manager, array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($container
      ->get('entity_type.manager'), $configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $default_terms = [];
    if (!empty($this->configuration['tid'])) {

      // Load the existing term(s) for the block.
      $terms = $this->configuration['tid'];
      if (!empty($terms)) {
        if (is_array($terms)) {
          foreach ($terms as $key => $term) {
            $term = array_pop($term);
            $default_terms[] = $this->entityTypeManager
              ->getStorage('taxonomy_term')
              ->load($term);
          }
        }
        else {
          $default_terms = $this->entityTypeManager
            ->getStorage('taxonomy_term')
            ->load($terms);
        }
      }
    }
    $form['tid'] = array(
      '#type' => 'entity_autocomplete',
      '#title' => $this
        ->t('Select taxonomy term(s)'),
      '#default_value' => $default_terms,
      '#target_type' => 'taxonomy_term',
      '#tags' => TRUE,
    );
    return parent::buildConfigurationForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'tid' => NULL,
    ] + parent::defaultConfiguration();
  }

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

  /**
   * Evaluates the condition and returns TRUE or FALSE accordingly.
   *
   * @return bool
   *   TRUE if the condition has been met, FALSE otherwise.
   */
  public function evaluate() {
    if (empty($this->configuration['tid']) && !$this
      ->isNegated()) {
      return TRUE;
    }

    // If configuration['tid'] is an array, there is multiple terms set.
    if (is_array($this->configuration['tid'])) {
      $tids = $this->configuration['tid'];
      unset($this->configuration['tid']);
      foreach ($tids as $tid) {
        $this->configuration['tid'][] = array_pop($tid);
      }
    }
    $entity = $this
      ->getContextValue('node');

    // Not in a node context. Try a few other options.
    if (!$entity) {

      // Potential other ways to try fetch the entity. Assoc array to try get revisions.
      // I wonder if there is a cleaner way to do this?
      // TODO - Provide hook to add extras.
      $potentialRouteMatches = [
        'taxonomy_term' => 'taxonomy_term',
        'node' => 'node_revision',
      ];
      foreach ($potentialRouteMatches as $key => $potentialRouteMatch) {
        $entity = \Drupal::routeMatch()
          ->getParameter($potentialRouteMatch);

        // If the entity extends EntityInterface, we have the entity we want.
        if ($entity instanceof EntityInterface) {
          break;
        }
        elseif (is_string($entity)) {

          // If the entity is a string, its likely the revision ID,
          // try load that.
          $entity = $this->entityTypeManager
            ->getStorage($key)
            ->loadRevision($entity);
          break;
        }
      }

      // All checks failed. Stop.
      if (!$entity) {
        return FALSE;
      }
    }
    foreach ($entity
      ->referencedEntities() as $referenced_entity) {

      // If configuration['tid'] is an array with multiple terms, check all
      // tids in the array against the term.
      if (is_array($this->configuration['tid'])) {
        if ($referenced_entity
          ->getEntityTypeId() == 'taxonomy_term' && in_array($referenced_entity
          ->id(), $this->configuration['tid'])) {
          return TRUE;
        }
      }
      else {
        if ($referenced_entity
          ->getEntityTypeId() == 'taxonomy_term' && $referenced_entity
          ->id() == $this->configuration['tid']) {
          return TRUE;
        }
      }
    }
    return FALSE;
  }

  /**
   * Provides a human readable summary of the condition's configuration.
   */
  public function summary() {
    $terms = [];
    $term_ids = $this->configuration['tid'];
    foreach ($term_ids as $term_id) {
      $terms[] = $this->entityTypeManager
        ->getStorage('taxonomy_term')
        ->load(array_pop($term_id))
        ->getName();
    }
    $term_list = implode(", ", $terms);
    if (!empty($this->configuration['negate'])) {
      return $this
        ->t('The node is not associated with taxonomy term(s) @term_list.', array(
        '@term_list' => $term_list,
      ));
    }
    else {
      return $this
        ->t('The node is associated with taxonomy term(s) @term_list.', array(
        '@term_list' => $term_list,
      ));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConditionPluginBase::$executableManager protected property The condition manager to proxy execute calls through.
ConditionPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
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
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
Term::$entityTypeManager protected property Entity manager instance.
Term::buildConfigurationForm public function Form constructor. Overrides ConditionPluginBase::buildConfigurationForm
Term::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
Term::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConditionPluginBase::defaultConfiguration
Term::evaluate public function Evaluates the condition and returns TRUE or FALSE accordingly. Overrides ConditionInterface::evaluate
Term::submitConfigurationForm public function Form submission handler. Overrides ConditionPluginBase::submitConfigurationForm
Term::summary public function Provides a human readable summary of the condition's configuration. Overrides ConditionInterface::summary
Term::__construct public function Creates a new ExampleCondition instance. Overrides ConditionPluginBase::__construct
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