class EntityBundle
Provides the 'Entity Bundle' condition.
Plugin annotation
@Condition(
id = "entity_bundle",
deriver = "\Drupal\Core\Entity\Plugin\Condition\Deriver\EntityBundle",
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Executable\ExecutablePluginBase implements \Drupal\Core\Executable\ExecutableInterface, \Drupal\Core\Cache\CacheableDependencyInterface, \Drupal\Core\Plugin\ContextAwarePluginInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Condition\ConditionPluginBase implements \Drupal\Core\Condition\ConditionInterface uses \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait extends \Drupal\Core\Executable\ExecutablePluginBase
- class \Drupal\Core\Entity\Plugin\Condition\EntityBundle implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\Core\Condition\ConditionPluginBase
- class \Drupal\Core\Condition\ConditionPluginBase implements \Drupal\Core\Condition\ConditionInterface uses \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait extends \Drupal\Core\Executable\ExecutablePluginBase
- class \Drupal\Core\Executable\ExecutablePluginBase implements \Drupal\Core\Executable\ExecutableInterface, \Drupal\Core\Cache\CacheableDependencyInterface, \Drupal\Core\Plugin\ContextAwarePluginInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of EntityBundle
File
-
core/
lib/ Drupal/ Core/ Entity/ Plugin/ Condition/ EntityBundle.php, line 19
Namespace
Drupal\Core\Entity\Plugin\ConditionView 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 | |
| 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. | ||
| ContextAwarePluginTrait::$context | protected | property | The data objects representing the context of this plugin. | ||
| ContextAwarePluginTrait::$initializedContextConfig | protected | property | Tracks whether the context has been initialized from configuration. | ||
| ContextAwarePluginTrait::getCacheContexts | public | function | 9 | ||
| ContextAwarePluginTrait::getCacheMaxAge | public | function | 7 | ||
| ContextAwarePluginTrait::getCacheTags | public | function | 4 | ||
| ContextAwarePluginTrait::getContext | public | function | |||
| ContextAwarePluginTrait::getContextDefinition | public | function | |||
| ContextAwarePluginTrait::getContextDefinitions | public | function | |||
| ContextAwarePluginTrait::getContextMapping | public | function | |||
| 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 | |||
| 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 | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | |
| 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. | ||
| MessengerTrait::$messenger | protected | property | The messenger. | 27 | |
| MessengerTrait::messenger | public | function | Gets the messenger. | 27 | |
| MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
| 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::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. | 3 | |
| 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 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.