You are here

Home » API reference » Business Rules 2.x » Condition.php

class Condition in Business Rules 2.x

Same name and namespace in other branches
  1. 8 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",
  config_export = {
    "id",
    "label",
    "type",
    "reverse",
    "description",
    "target_entity_type",
    "target_bundle",
    "success_items",
    "fail_items",
    "tags",
    "settings"
  },
  admin_permission = "administer site configuration",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "uuid" = "uuid"
  },
  config_export = {
    "id",
    "label",
    "description",
    "settings",
    "tags",
    "uuid",
    "type",
    "target_entity_type",
    "target_bundle",
  },
  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

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

... See full list

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.

... See full list

File

src/Entity/Condition.php, line 66

Namespace

Drupal\business_rules\Entity
View 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

Namesort descending Modifiers Type Description Overrides
BusinessRulesItemBase::$description protected property The Item description.
BusinessRulesItemBase::$eventDispatcher protected property The event dispatcher.
BusinessRulesItemBase::$id protected property The Item ID.
BusinessRulesItemBase::$itemManager protected property Item plugin manager.
BusinessRulesItemBase::$label protected property The Item label.
BusinessRulesItemBase::$settings protected property The item settings.
BusinessRulesItemBase::$tags protected property The tags to mark this entity.
BusinessRulesItemBase::$target_bundle protected property The target entity bundle id which this item is applicable.
BusinessRulesItemBase::$target_entity_type protected property The entity type id which this item is applicable.
BusinessRulesItemBase::$type protected property The item type.
BusinessRulesItemBase::$util protected property The Business Rules Util.
BusinessRulesItemBase::delete public function Deletes an entity permanently. Overrides EntityBase::delete
BusinessRulesItemBase::getDescription public function Get the item description. Overrides ItemInterface::getDescription
BusinessRulesItemBase::getReactOnEvents public function Get the reactsOn ids applicable for the item. Overrides ItemInterface::getReactOnEvents
BusinessRulesItemBase::getSettings public function Return the item settings. Overrides ItemInterface::getSettings
BusinessRulesItemBase::getTags public function Get the tags value. Overrides ItemInterface::getTags
BusinessRulesItemBase::getTargetBundle public function Return the target entity bundle id which this item is applicable. Overrides ItemInterface::getTargetBundle
BusinessRulesItemBase::getTargetEntityType public function Return the entity type id which this item is applicable. Overrides ItemInterface::getTargetEntityType
BusinessRulesItemBase::getType public function Get the item type. Overrides ItemInterface::getType
BusinessRulesItemBase::getTypeLabel public function Get the readable Type label. Overrides ItemInterface::getTypeLabel
BusinessRulesItemBase::getTypes public function Get all item types available. Overrides ItemInterface::getTypes
BusinessRulesItemBase::getVariables public function Get the variables being used by the item. Overrides ItemInterface::getVariables
BusinessRulesItemBase::isContextDependent public function Is the item context dependent? Overrides ItemInterface::isContextDependent
BusinessRulesItemBase::loadAllTags public static function Load all Business Rule's tags. Overrides ItemInterface::loadAllTags
BusinessRulesItemBase::loadMultipleByType public static function Load multiple items by type. Overrides ItemInterface::loadMultipleByType
BusinessRulesItemBase::setSetting public function Set a value to the Item Settings. Overrides ItemInterface::setSetting
BusinessRulesItemBase::setTags public function Set the tags value. Overrides ItemInterface::setTags
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
Condition::$fail_items protected property Items to be executed if condition fails.
Condition::$reverse protected property If it's a reverse condition (NOT).
Condition::$success_items protected property Items to be executed if condition succeed.
Condition::addFailItem public function Add one item for Condition fail. Overrides ConditionInterface::addFailItem
Condition::addSuccessItem public function Add one item for Condition success. Overrides ConditionInterface::addSuccessItem
Condition::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides BusinessRulesItemBase::calculateDependencies
Condition::filterContextAvailableItems public function Return a list of Conditions|Actions compatible with the Condition. Overrides ConditionInterface::filterContextAvailableItems
Condition::getBusinessRuleItemTranslatedType public function Get the Item type translated. Action|Condition. Overrides ItemInterface::getBusinessRuleItemTranslatedType
Condition::getBusinessRuleItemType public function Get the Item type: action|condition. Overrides ItemInterface::getBusinessRuleItemType
Condition::getFailItems public function Get all condition's fail items. Overrides ConditionInterface::getFailItems
Condition::getItemManager public function Get the plugin manager. Overrides BusinessRulesItemBase::getItemManager
Condition::getMaxItemWeight public function Get the current max item weight. Overrides ConditionInterface::getMaxItemWeight
Condition::getSuccessItems public function Get all condition's success items. Overrides ConditionInterface::getSuccessItems
Condition::isReverse public function If it's a reverse condition (NOT). Overrides ConditionInterface::isReverse
Condition::process public function Process the condition. Overrides ConditionInterface::process
Condition::removeFailItem public function Remove one fail item from the condition. Overrides ConditionInterface::removeFailItem
Condition::removeSuccessItem public function Remove one success item from the condition. Overrides ConditionInterface::removeSuccessItem
Condition::save public function Saves an entity permanently. Overrides ConfigEntityBase::save
Condition::__construct public function Constructs an Entity object. Overrides BusinessRulesItemBase::__construct
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 8
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 13
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 2
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id public function Gets the identifier. Overrides EntityInterface::id 11
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 4
EntityBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 18
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 14
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 7
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SynchronizableEntityTrait::$isSyncing protected property Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function