class EntityBundleConstraint

Entity Bundle Constraints

Adds constraints to Drupal\Core\Entity\Plugin\Condition\EntityBundle.

Hierarchy

Expanded class hierarchy of EntityBundleConstraint

1 file declares its use of EntityBundleConstraint
ctools.module in ./ctools.module
Provides utility and helper APIs for Drupal developers and site builders.

File

src/Plugin/Condition/EntityBundleConstraint.php, line 13

Namespace

Drupal\ctools\Plugin\Condition
View source 
class EntityBundleConstraint extends CoreEntityBundle implements ConstraintConditionInterface {
    
    /**
     * {@inheritdoc}
     *
     * @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
     */
    public function applyConstraints(array $contexts = []) {
        // Nullify any bundle constraints on contexts we care about.
        $this->removeConstraints($contexts);
        $bundle = array_values($this->configuration['bundles']);
        // There's only one expected context for this plugin type.
        foreach ($this->getContextMapping() as $definition_id => $context_id) {
            $contexts[$context_id]->getContextDefinition()
                ->addConstraint('Bundle', [
                'value' => $bundle,
            ]);
        }
    }
    
    /**
     * {@inheritdoc}
     *
     * @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
     */
    public function removeConstraints(array $contexts = []) {
        // Reset the bundle constraint for any context we've mapped.
        foreach ($this->getContextMapping() as $definition_id => $context_id) {
            $constraints = $contexts[$context_id]->getContextDefinition()
                ->getConstraints();
            unset($constraints['Bundle']);
            $contexts[$context_id]->getContextDefinition()
                ->setConstraints($constraints);
        }
    }

}

Members

Title Modifiers Object type Summary Overriden Title 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 1
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 1
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.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::getCacheContexts public function 10
ContextAwarePluginTrait::getCacheMaxAge public function 6
ContextAwarePluginTrait::getCacheTags public function 3
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function 1
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::getPluginDefinition abstract public function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
EntityBundle::$entityTypeBundleInfo protected property The entity type bundle info service.
EntityBundle::buildConfigurationForm public function Form constructor. Overrides ConditionPluginBase::buildConfigurationForm
EntityBundle::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
EntityBundle::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConditionPluginBase::defaultConfiguration
EntityBundle::evaluate public function Evaluates the condition and returns TRUE or FALSE accordingly. Overrides ConditionInterface::evaluate
EntityBundle::submitConfigurationForm public function Form submission handler. Overrides ConditionPluginBase::submitConfigurationForm
EntityBundle::summary public function Provides a human readable summary of the condition's configuration. Overrides ConditionInterface::summary
EntityBundle::__construct public function Creates a new EntityBundle instance. Overrides ConditionPluginBase::__construct
EntityBundleConstraint::applyConstraints public function Overrides ConstraintConditionInterface::applyConstraints
EntityBundleConstraint::removeConstraints public function Overrides ConstraintConditionInterface::removeConstraints
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.
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2