class EntityBundle

Same name in this branch
  1. 10 core/lib/Drupal/Core/Entity/Plugin/Condition/Deriver/EntityBundle.php \Drupal\Core\Entity\Plugin\Condition\Deriver\EntityBundle
Same name in other branches
  1. 9 core/lib/Drupal/Core/Entity/Plugin/Condition/Deriver/EntityBundle.php \Drupal\Core\Entity\Plugin\Condition\Deriver\EntityBundle
  2. 9 core/lib/Drupal/Core/Entity/Plugin/Condition/EntityBundle.php \Drupal\Core\Entity\Plugin\Condition\EntityBundle
  3. 11.x core/lib/Drupal/Core/Entity/Plugin/Condition/Deriver/EntityBundle.php \Drupal\Core\Entity\Plugin\Condition\Deriver\EntityBundle
  4. 11.x core/lib/Drupal/Core/Entity/Plugin/Condition/EntityBundle.php \Drupal\Core\Entity\Plugin\Condition\EntityBundle

Provides the 'Entity Bundle' condition.

Hierarchy

Expanded class hierarchy of EntityBundle

File

core/lib/Drupal/Core/Entity/Plugin/Condition/EntityBundle.php, line 16

Namespace

Drupal\Core\Entity\Plugin\Condition
View source
class EntityBundle extends ConditionPluginBase implements ContainerFactoryPluginInterface {
    
    /**
     * The entity type bundle info service.
     *
     * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
     */
    protected $entityTypeBundleInfo;
    
    /**
     * Creates a new EntityBundle instance.
     *
     * @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.
     * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
     *   The entity type bundle info service.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeBundleInfoInterface $entity_type_bundle_info) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->entityTypeBundleInfo = $entity_type_bundle_info;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('entity_type.bundle.info'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
        $bundles = $this->entityTypeBundleInfo
            ->getBundleInfo($this->getDerivativeId());
        $form['bundles'] = [
            '#title' => $this->pluginDefinition['label'],
            '#type' => 'checkboxes',
            '#options' => array_combine(array_keys($bundles), array_column($bundles, 'label')),
            '#default_value' => $this->configuration['bundles'],
        ];
        return parent::buildConfigurationForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
        $this->configuration['bundles'] = array_filter($form_state->getValue('bundles'));
        parent::submitConfigurationForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function evaluate() {
        // Returns true if no bundles are selected and negate option is disabled.
        if (empty($this->configuration['bundles']) && !$this->isNegated()) {
            return TRUE;
        }
        
        /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
        $entity = $this->getContextValue($this->getDerivativeId());
        return !empty($this->configuration['bundles'][$entity->bundle()]);
    }
    
    /**
     * {@inheritdoc}
     */
    public function summary() {
        if (count($this->configuration['bundles']) > 1) {
            $bundles = $this->configuration['bundles'];
            $last = array_pop($bundles);
            $bundles = implode(', ', $bundles);
            if (empty($this->configuration['negate'])) {
                return $this->t('@bundle_type is @bundles or @last', [
                    '@bundle_type' => $this->pluginDefinition['label'],
                    '@bundles' => $bundles,
                    '@last' => $last,
                ]);
            }
            else {
                return $this->t('@bundle_type is not @bundles or @last', [
                    '@bundle_type' => $this->pluginDefinition['label'],
                    '@bundles' => $bundles,
                    '@last' => $last,
                ]);
            }
        }
        $bundle = reset($this->configuration['bundles']);
        if (empty($this->configuration['negate'])) {
            return $this->t('@bundle_type is @bundle', [
                '@bundle_type' => $this->pluginDefinition['label'],
                '@bundle' => $bundle,
            ]);
        }
        else {
            return $this->t('@bundle_type is not @bundle', [
                '@bundle_type' => $this->pluginDefinition['label'],
                '@bundle' => $bundle,
            ]);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function defaultConfiguration() {
        return [
            'bundles' => [],
        ] + parent::defaultConfiguration();
    }

}

Members

Title Sort descending 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
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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.