class Condition in Business Rules 8
Same name and namespace in other branches
- 2.x src/Entity/Condition.php \Drupal\business_rules\Entity\Condition
Defines the Condition entity.
Plugin annotation
@ConfigEntityType(
id = "business_rules_condition",
label = @Translation("Business Rules Condition"),
handlers = {
"list_builder" = "Drupal\business_rules\ConditionListBuilder",
"form" = {
"add" = "Drupal\business_rules\Form\ConditionForm",
"edit" = "Drupal\business_rules\Form\ConditionForm",
"delete" = "Drupal\business_rules\Form\ConditionDeleteForm"
},
"route_provider" = {
"html" = "Drupal\business_rules\ConditionHtmlRouteProvider",
},
},
config_prefix = "condition",
admin_permission = "administer site configuration",
entity_keys = {
"id" = "id",
"label" = "label",
"uuid" = "uuid"
},
links = {
"canonical" = "/admin/config/workflow/business_rules/condition/{business_rules_condition}",
"add-form" = "/admin/config/workflow/business_rules/condition/add",
"edit-form" = "/admin/config/workflow/business_rules/condition/{business_rules_condition}/edit",
"delete-form" = "/admin/config/workflow/business_rules/condition/{business_rules_condition}/delete",
"collection" = "/admin/config/workflow/business_rules/condition/collection/{view_mode}"
}
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
- class \Drupal\business_rules\Entity\BusinessRulesItemBase implements ItemInterface
- class \Drupal\business_rules\Entity\Condition implements ConditionInterface
- class \Drupal\business_rules\Entity\BusinessRulesItemBase implements ItemInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
Expanded class hierarchy of Condition
21 files declare their use of Condition
- AutocompleteTags.php in src/
Controller/ AutocompleteTags.php - BusinessRuleForm.php in src/
Form/ BusinessRuleForm.php - BusinessRulesItemObject.php in src/
BusinessRulesItemObject.php - BusinessRulesItemsController.php in src/
Controller/ BusinessRulesItemsController.php - BusinessRulesProcessor.php in src/
Util/ BusinessRulesProcessor.php
7 string references to 'Condition'
- BusinessRulesItemsController::init in src/
Controller/ BusinessRulesItemsController.php - Init properties.
- BusinessRulesProcessor::getDebugItems in src/
Util/ BusinessRulesProcessor.php - Helper function to prepare the render array for the Business Rules Items.
- Condition::getBusinessRuleItemTranslatedType in src/
Entity/ Condition.php - Get the Item type translated. Action|Condition.
- ConditionSetController::init in src/
Controller/ ConditionSetController.php - Init properties.
- ConditionsItemsController::init in src/
Controller/ ConditionsItemsController.php - Init properties.
File
- src/
Entity/ Condition.php, line 42
Namespace
Drupal\business_rules\EntityView source
class Condition extends BusinessRulesItemBase implements ConditionInterface {
/**
* Items to be executed if condition fails.
*
* @var array
*/
protected $fail_items = [];
/**
* If it's a reverse condition (NOT).
*
* @var bool
*/
protected $reverse;
/**
* Items to be executed if condition succeed.
*
* @var array
*/
protected $success_items = [];
/**
* {@inheritdoc}
*/
public function __construct(array $values, $entity_type = 'business_rules_condition') {
parent::__construct($values, $entity_type);
}
/**
* {@inheritdoc}
*/
public function getItemManager() {
return \Drupal::getContainer()
->get('plugin.manager.business_rules.condition');
}
/**
* {@inheritdoc}
*/
public function getBusinessRuleItemType() {
return 'condition';
}
/**
* {@inheritdoc}
*/
public function getBusinessRuleItemTranslatedType() {
return t('Condition');
}
/**
* {@inheritdoc}
*/
public function save() {
// Prevent condition to have the same name as one existent action.
$action = Action::load($this
->id());
if (!empty($action)) {
$this->id = 'c_' . $this
->id();
}
return parent::save();
}
/**
* {@inheritdoc}
*/
public function isReverse() {
return (bool) $this->reverse;
}
/**
* {@inheritdoc}
*/
public function getSuccessItems() {
$success_items = BusinessRulesItemObject::itemsArrayToItemsObject($this->success_items);
return $success_items;
}
/**
* {@inheritdoc}
*/
public function getFailItems() {
$fail_items = BusinessRulesItemObject::itemsArrayToItemsObject($this->fail_items);
return $fail_items;
}
/**
* {@inheritdoc}
*/
public function removeSuccessItem(BusinessRulesItemObject $item) {
unset($this->success_items[$item
->getId()]);
}
/**
* {@inheritdoc}
*/
public function removeFailItem(BusinessRulesItemObject $item) {
unset($this->fail_items[$item
->getId()]);
}
/**
* {@inheritdoc}
*/
public function filterContextAvailableItems(array $items) {
/** @var \Drupal\business_rules\ItemInterface $value */
$entity_type = $this
->getTargetEntityType();
$bundle = $this
->getTargetBundle();
$available_items = [];
foreach ($items as $key => $value) {
// Evaluate Target Entity Type.
if ((($value
->getTargetEntityType() == $entity_type || empty($value
->getTargetEntityType())) && ($value
->getTargetBundle() == $bundle || empty($value
->getTargetBundle())) || !$value
->isContextDependent()) && $this
->id() != $value
->id()) {
$available_items[$key] = $value;
}
}
return $available_items;
}
/**
* {@inheritdoc}
*/
public function getMaxItemWeight($success = TRUE) {
if ($success) {
$items = $this->success_items;
}
else {
$items = $this->fail_items;
}
$max = -10;
if (is_array($items)) {
foreach ($items as $item) {
if ($max < $item['weight']) {
$max = $item['weight'];
}
}
}
return $max;
}
/**
* {@inheritdoc}
*/
public function addSuccessItem(BusinessRulesItemObject $item) {
$item_array = $item
->toArray();
$this->success_items[$item
->getId()] = $item_array[$item
->getId()];
}
/**
* {@inheritdoc}
*/
public function addFailItem(BusinessRulesItemObject $item) {
$item_array = $item
->toArray();
$this->fail_items[$item
->getId()] = $item_array[$item
->getId()];
}
/**
* {@inheritdoc}
*/
public function process(BusinessRulesEvent $event) {
$condition_type = $this->itemManager
->getDefinition($this
->getType());
$reflection = new \ReflectionClass($condition_type['class']);
/** @var \Drupal\business_rules\Plugin\BusinessRulesConditionPlugin $defined_condition */
$defined_condition = $reflection
->newInstance($condition_type, $condition_type['id'], $condition_type);
$condition = Condition::load($this
->id());
$defined_condition
->processTokens($condition, $event);
return $defined_condition
->process($condition, $event);
}
/**
* {@inheritdoc}
*/
public function calculateDependencies() {
parent::calculateDependencies();
/** @var \Drupal\business_rules\BusinessRulesItemObject $item */
foreach (array_merge($this
->getSuccessItems(), $this
->getFailItems()) as $item) {
$this
->addDependency('config', $item
->loadEntity()
->getConfigDependencyName());
}
$items = $this
->getSettings('items');
if (is_array($items)) {
foreach (BusinessRulesItemObject::itemsArrayToItemsObject($items) as $item) {
$this
->addDependency('config', $item
->loadEntity()
->getConfigDependencyName());
}
}
return $this;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BusinessRulesItemBase:: |
protected | property | The Item description. | |
BusinessRulesItemBase:: |
protected | property | The event dispatcher. | |
BusinessRulesItemBase:: |
protected | property | The Item ID. | |
BusinessRulesItemBase:: |
protected | property | Item plugin manager. | |
BusinessRulesItemBase:: |
protected | property | The Item label. | |
BusinessRulesItemBase:: |
protected | property | The item settings. | |
BusinessRulesItemBase:: |
protected | property | The tags to mark this entity. | |
BusinessRulesItemBase:: |
protected | property | The target entity bundle id which this item is applicable. | |
BusinessRulesItemBase:: |
protected | property | The entity type id which this item is applicable. | |
BusinessRulesItemBase:: |
protected | property | The item type. | |
BusinessRulesItemBase:: |
protected | property | The Business Rules Util. | |
BusinessRulesItemBase:: |
public | function |
Deletes an entity permanently. Overrides EntityBase:: |
|
BusinessRulesItemBase:: |
public | function |
Get the item description. Overrides ItemInterface:: |
|
BusinessRulesItemBase:: |
public | function |
Get the reactsOn ids applicable for the item. Overrides ItemInterface:: |
|
BusinessRulesItemBase:: |
public | function |
Return the item settings. Overrides ItemInterface:: |
|
BusinessRulesItemBase:: |
public | function |
Get the tags value. Overrides ItemInterface:: |
|
BusinessRulesItemBase:: |
public | function |
Return the target entity bundle id which this item is applicable. Overrides ItemInterface:: |
|
BusinessRulesItemBase:: |
public | function |
Return the entity type id which this item is applicable. Overrides ItemInterface:: |
|
BusinessRulesItemBase:: |
public | function |
Get the item type. Overrides ItemInterface:: |
|
BusinessRulesItemBase:: |
public | function |
Get the readable Type label. Overrides ItemInterface:: |
|
BusinessRulesItemBase:: |
public | function |
Get all item types available. Overrides ItemInterface:: |
|
BusinessRulesItemBase:: |
public | function |
Get the variables being used by the item. Overrides ItemInterface:: |
|
BusinessRulesItemBase:: |
public | function |
Is the item context dependent? Overrides ItemInterface:: |
|
BusinessRulesItemBase:: |
public static | function |
Load all Business Rule's tags. Overrides ItemInterface:: |
|
BusinessRulesItemBase:: |
public static | function |
Load multiple items by type. Overrides ItemInterface:: |
|
BusinessRulesItemBase:: |
public | function |
Set a value to the Item Settings. Overrides ItemInterface:: |
|
BusinessRulesItemBase:: |
public | function |
Set the tags value. Overrides ItemInterface:: |
|
CacheableDependencyTrait:: |
protected | property | Cache contexts. | |
CacheableDependencyTrait:: |
protected | property | Cache max-age. | |
CacheableDependencyTrait:: |
protected | property | Cache tags. | |
CacheableDependencyTrait:: |
protected | function | Sets cacheability; useful for value object constructors. | |
Condition:: |
protected | property | Items to be executed if condition fails. | |
Condition:: |
protected | property | If it's a reverse condition (NOT). | |
Condition:: |
protected | property | Items to be executed if condition succeed. | |
Condition:: |
public | function |
Add one item for Condition fail. Overrides ConditionInterface:: |
|
Condition:: |
public | function |
Add one item for Condition success. Overrides ConditionInterface:: |
|
Condition:: |
public | function |
Calculates dependencies and stores them in the dependency property. Overrides BusinessRulesItemBase:: |
|
Condition:: |
public | function |
Return a list of Conditions|Actions compatible with the Condition. Overrides ConditionInterface:: |
|
Condition:: |
public | function |
Get the Item type translated. Action|Condition. Overrides ItemInterface:: |
|
Condition:: |
public | function |
Get the Item type: action|condition. Overrides ItemInterface:: |
|
Condition:: |
public | function |
Get all condition's fail items. Overrides ConditionInterface:: |
|
Condition:: |
public | function |
Get the plugin manager. Overrides BusinessRulesItemBase:: |
|
Condition:: |
public | function |
Get the current max item weight. Overrides ConditionInterface:: |
|
Condition:: |
public | function |
Get all condition's success items. Overrides ConditionInterface:: |
|
Condition:: |
public | function |
If it's a reverse condition (NOT). Overrides ConditionInterface:: |
|
Condition:: |
public | function |
Process the condition. Overrides ConditionInterface:: |
|
Condition:: |
public | function |
Remove one fail item from the condition. Overrides ConditionInterface:: |
|
Condition:: |
public | function |
Remove one success item from the condition. Overrides ConditionInterface:: |
|
Condition:: |
public | function |
Saves an entity permanently. Overrides ConfigEntityBase:: |
|
Condition:: |
public | function |
Constructs an Entity object. Overrides BusinessRulesItemBase:: |
|
ConfigEntityBase:: |
private | property | Whether the config is being deleted by the uninstall process. | |
ConfigEntityBase:: |
protected | property | The language code of the entity's default language. | |
ConfigEntityBase:: |
protected | property | The original ID of the configuration entity. | |
ConfigEntityBase:: |
protected | property | The enabled/disabled status of the configuration entity. | 4 |
ConfigEntityBase:: |
protected | property | Third party entity settings. | |
ConfigEntityBase:: |
protected | property | Trust supplied data and not use configuration schema on save. | |
ConfigEntityBase:: |
protected | property | The UUID for this entity. | |
ConfigEntityBase:: |
protected | property | Information maintained by Drupal core about configuration. | |
ConfigEntityBase:: |
protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |
ConfigEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Disables the configuration entity. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Enables the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Gets the configuration dependency name. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected static | function | Gets the configuration manager. | |
ConfigEntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the configuration dependencies. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
protected | function | Gets the typed config manager. | |
ConfigEntityBase:: |
public | function |
Gets whether on not the data is trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
protected static | function |
Override to never invalidate the individual entities' cache tags; the
config system already invalidates them. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected | function |
Override to never invalidate the entity's cache tag; the config system
already invalidates it. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Checks whether this entity is installable. Overrides ConfigEntityInterface:: |
2 |
ConfigEntityBase:: |
public | function |
Overrides Entity::isNew(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface:: |
7 |
ConfigEntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase:: |
8 |
ConfigEntityBase:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides EntityBase:: |
13 |
ConfigEntityBase:: |
public | function |
Sets the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets the status of the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function | ||
ConfigEntityBase:: |
public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | 6 |
ConfigEntityBase:: |
public | function |
Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface:: |
4 |
ConfigEntityBase:: |
public | function |
Gets an array of all property values. Overrides EntityBase:: |
2 |
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets that the data should be trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the public URL for this entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Overrides EntityBase:: |
4 |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | Aliased as: traitSleep | 1 |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. Aliased as: addDependencyTrait | |
EntityBase:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
EntityBase:: |
protected | property | The entity type. | |
EntityBase:: |
protected | property | A typed data object wrapping this entity. | |
EntityBase:: |
public | function |
Checks data value access. Overrides AccessibleInterface:: |
1 |
EntityBase:: |
public | function |
Gets the bundle of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public static | function |
Constructs a new entity object, without permanently saving it. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets the entity manager. | |
EntityBase:: |
protected | function | Gets the entity type bundle info service. | |
EntityBase:: |
protected | function | Gets the entity type manager. | |
EntityBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | The list cache tags to invalidate for this entity. | |
EntityBase:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the identifier. Overrides EntityInterface:: |
11 |
EntityBase:: |
public | function |
Gets the label of the entity. Overrides EntityInterface:: |
6 |
EntityBase:: |
public | function |
Gets the language of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the language manager. | |
EntityBase:: |
protected | function | Gets an array link templates. | 1 |
EntityBase:: |
public static | function |
Loads an entity. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Loads one or more entities. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Acts on a created entity before hooks are invoked. Overrides EntityInterface:: |
4 |
EntityBase:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface:: |
16 |
EntityBase:: |
public static | function |
Acts on loaded entities. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface:: |
14 |
EntityBase:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityInterface:: |
5 |
EntityBase:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets an array of placeholders for this entity. | 2 |
EntityBase:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the UUID generator. | |
PluginDependencyTrait:: |
protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 |
PluginDependencyTrait:: |
protected | function | Calculates and returns dependencies of a specific plugin instance. | |
PluginDependencyTrait:: |
protected | function | Wraps the module handler. | 1 |
PluginDependencyTrait:: |
protected | function | Wraps the theme handler. | 1 |
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
protected | property | Whether this entity is being created, updated or deleted through a synchronization process. | |
SynchronizableEntityTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
public | function |