ConditionPluginBase.php

<?php

namespace Drupal\Core\Condition;

use Drupal\Core\Executable\ExecutableManagerInterface;
use Drupal\Core\Executable\ExecutablePluginBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Form\SubformStateInterface;
use Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait;

/**
 * Provides a basis for fulfilling contexts for condition plugins.
 *
 * @see \Drupal\Core\Condition\Annotation\Condition
 * @see \Drupal\Core\Condition\Attribute\Condition
 * @see \Drupal\Core\Condition\ConditionInterface
 * @see \Drupal\Core\Condition\ConditionManager
 *
 * @ingroup plugin_api
 */
abstract class ConditionPluginBase extends ExecutablePluginBase implements ConditionInterface {
    use ContextAwarePluginAssignmentTrait;
    
    /**
     * The condition manager to proxy execute calls through.
     *
     * @var \Drupal\Core\Executable\ExecutableManagerInterface
     */
    protected $executableManager;
    
    /**
     * {@inheritdoc}
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->setConfiguration($configuration);
    }
    
    /**
     * {@inheritdoc}
     */
    public function isNegated() {
        return !empty($this->configuration['negate']);
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
        if ($form_state instanceof SubformStateInterface) {
            $form_state = $form_state->getCompleteFormState();
        }
        $contexts = $form_state->getTemporaryValue('gathered_contexts') ?: [];
        $form['context_mapping'] = $this->addContextAssignmentElement($this, $contexts);
        $form['negate'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Negate the condition'),
            '#default_value' => $this->configuration['negate'],
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
        $this->configuration['negate'] = $form_state->getValue('negate');
        if ($form_state->hasValue('context_mapping')) {
            $this->setContextMapping($form_state->getValue('context_mapping'));
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function execute() {
        return $this->executableManager
            ->execute($this);
    }
    
    /**
     * {@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 defaultConfiguration() {
        return [
            'negate' => FALSE,
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function calculateDependencies() {
        return [];
    }
    
    /**
     * {@inheritdoc}
     */
    public function setExecutableManager(ExecutableManagerInterface $executableManager) {
        $this->executableManager = $executableManager;
        return $this;
    }

}