interface ConditionInterface in Business Rules 8

Same name and namespace in other branches

2.x src/ConditionInterface.php \Drupal\business_rules\ConditionInterface

Provides an interface for defining Condition entities.

Hierarchy

interface \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\Core\Entity\SynchronizableInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface
  - interface \Drupal\business_rules\ItemInterface
    interface \Drupal\business_rules\ConditionInterface

Expanded class hierarchy of ConditionInterface

All classes that implement ConditionInterface

16 files declare their use of ConditionInterface

BusinessRulesConditionPlugin.php in src/Plugin/BusinessRulesConditionPlugin.php
BusinessRulesConditionPluginInterface.php in src/Plugin/BusinessRulesConditionPluginInterface.php
CheckViewResultCount.php in src/Plugin/BusinessRulesCondition/CheckViewResultCount.php
CompareNumberOfResultsBetweenTwoViews.php in src/Plugin/BusinessRulesCondition/CompareNumberOfResultsBetweenTwoViews.php
Condition.php in src/Entity/Condition.php

... See full list

File

src/ConditionInterface.php, line 10

Namespace

Drupal\business_rules

View source

interface ConditionInterface extends ItemInterface {

  /**
   * If it's a reverse condition (NOT).
   *
   * @return bool
   *   If the condition is reverse.
   */
  public function isReverse();

  /**
   * Get all condition's success items.
   *
   * @return array
   *   Array of items to be executed if the condition succeed.
   */
  public function getSuccessItems();

  /**
   * Get all condition's fail items.
   *
   * @return array
   *   Array of items to be executed if the condition fails.
   */
  public function getFailItems();

  /**
   * Remove one success item from the condition.
   *
   * @param \Drupal\business_rules\BusinessRulesItemObject $item
   *   The item to be removed.
   */
  public function removeSuccessItem(BusinessRulesItemObject $item);

  /**
   * Remove one fail item from the condition.
   *
   * @param \Drupal\business_rules\BusinessRulesItemObject $item
   *   The item to be removed.
   */
  public function removeFailItem(BusinessRulesItemObject $item);

  /**
   * Return a list of Conditions|Actions compatible with the Condition.
   *
   * @param array $items
   *   Array of items.
   *
   * @return array
   *   The available items considering the condition context.
   */
  public function filterContextAvailableItems(array $items);

  /**
   * Get the current max item weight.
   *
   * @param bool $success
   *   - TRUE for items for condition succeed.
   *   - FALSE for items for condition fails.
   *
   * @return int
   *   The current max item weight.
   */
  public function getMaxItemWeight($success = TRUE);

  /**
   * Add one item for Condition success.
   *
   * @param \Drupal\business_rules\BusinessRulesItemObject $item
   *   The item to be added.
   */
  public function addSuccessItem(BusinessRulesItemObject $item);

  /**
   * Add one item for Condition fail.
   *
   * @param \Drupal\business_rules\BusinessRulesItemObject $item
   *   The item to be added.
   */
  public function addFailItem(BusinessRulesItemObject $item);

  /**
   * Process the condition.
   *
   * @param \Drupal\business_rules\Events\BusinessRulesEvent $event
   *   The event that has triggered the condition.
   *
   * @return bool
   *   Boolean value that indicates if the condition is true.
   *
   * @throws \ReflectionException
   */
  public function process(BusinessRulesEvent $event);

}

Members

Name	Modifiers	Type	Description	Overrides
AccessibleInterface::access	public	function	Checks data value access.	9
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	34
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	34
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	27
ConditionInterface::addFailItem	public	function	Add one item for Condition fail.	1
ConditionInterface::addSuccessItem	public	function	Add one item for Condition success.	1
ConditionInterface::filterContextAvailableItems	public	function	Return a list of Conditions\|Actions compatible with the Condition.	1
ConditionInterface::getFailItems	public	function	Get all condition's fail items.	1
ConditionInterface::getMaxItemWeight	public	function	Get the current max item weight.	1
ConditionInterface::getSuccessItems	public	function	Get all condition's success items.	1
ConditionInterface::isReverse	public	function	If it's a reverse condition (NOT).	1
ConditionInterface::process	public	function	Process the condition.	1
ConditionInterface::removeFailItem	public	function	Remove one fail item from the condition.	1
ConditionInterface::removeSuccessItem	public	function	Remove one success item from the condition.	1
ConfigEntityInterface::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property.	2
ConfigEntityInterface::disable	public	function	Disables the configuration entity.	2
ConfigEntityInterface::enable	public	function	Enables the configuration entity.	2
ConfigEntityInterface::get	public	function	Returns the value of a property.	2
ConfigEntityInterface::getDependencies	public	function	Gets the configuration dependencies.	2
ConfigEntityInterface::hasTrustedData	public	function	Gets whether on not the data is trusted.	2
ConfigEntityInterface::isInstallable	public	function	Checks whether this entity is installable.	2
ConfigEntityInterface::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process.	2
ConfigEntityInterface::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted.	2
ConfigEntityInterface::set	public	function	Sets the value of a property.	2
ConfigEntityInterface::setStatus	public	function	Sets the status of the configuration entity.	2
ConfigEntityInterface::status	public	function	Returns whether the configuration entity is enabled.	2
ConfigEntityInterface::trustData	public	function	Sets that the data should be trusted.	2
EntityInterface::bundle	public	function	Gets the bundle of the entity.	2
EntityInterface::create	public static	function	Constructs a new entity object, without permanently saving it.	2
EntityInterface::createDuplicate	public	function	Creates a duplicate of the entity.	2
EntityInterface::delete	public	function	Deletes an entity permanently.	2
EntityInterface::enforceIsNew	public	function	Enforces an entity to be new.	2
EntityInterface::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches.	2
EntityInterface::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies.	2
EntityInterface::getConfigDependencyName	public	function	Gets the configuration dependency name.	2
EntityInterface::getConfigTarget	public	function	Gets the configuration target identifier for the entity.	2
EntityInterface::getEntityType	public	function	Gets the entity type definition.	2
EntityInterface::getEntityTypeId	public	function	Gets the ID of the type of the entity.	2
EntityInterface::getOriginalId	public	function	Gets the original ID.	2
EntityInterface::getTypedData	public	function	Gets a typed data object for this entity object.	2
EntityInterface::hasLinkTemplate	public	function	Indicates if a link template exists for a given key.	2
EntityInterface::id	public	function	Gets the identifier.	2
EntityInterface::isNew	public	function	Determines whether the entity is new.	2
EntityInterface::language	public	function	Gets the language of the entity.	2
EntityInterface::link Deprecated	public	function	Deprecated way of generating a link to the entity. See toLink().	2
EntityInterface::load	public static	function	Loads an entity.	2
EntityInterface::loadMultiple	public static	function	Loads one or more entities.	2
EntityInterface::postCreate	public	function	Acts on a created entity before hooks are invoked.	2
EntityInterface::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked.	2
EntityInterface::postLoad	public static	function	Acts on loaded entities.	3
EntityInterface::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked.	2
EntityInterface::preCreate	public static	function	Changes the values of an entity before it is created.	2
EntityInterface::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked.	2
EntityInterface::preSave	public	function	Acts on an entity before the presave hook is invoked.	2
EntityInterface::referencedEntities	public	function	Gets a list of entities referenced by this entity.	2
EntityInterface::save	public	function	Saves an entity permanently.	2
EntityInterface::setOriginalId	public	function	Sets the original ID.	2
EntityInterface::toArray	public	function	Gets an array of all property values.	3
EntityInterface::toLink	public	function	Generates the HTML for a link to this entity.	2
EntityInterface::toUrl	public	function	Gets the URL object for the entity.	2
EntityInterface::uriRelationships	public	function	Gets a list of URI relationships supported by this entity.	2
EntityInterface::url Deprecated	public	function	Gets the public URL for this entity.	2
EntityInterface::urlInfo Deprecated	public	function	Gets the URL object for the entity.	2
EntityInterface::uuid	public	function	Gets the entity UUID (Universally Unique Identifier).	2
ItemInterface::getBusinessRuleItemTranslatedType	public	function	Get the Item type translated. Action\|Condition.	3
ItemInterface::getBusinessRuleItemType	public	function	Get the Item type: action\|condition.	3
ItemInterface::getDescription	public	function	Get the item description.	1
ItemInterface::getReactOnEvents	public	function	Get the reactsOn ids applicable for the item.	1
ItemInterface::getSettings	public	function	Return the item settings.	1
ItemInterface::getTags	public	function	Get the tags value.	1
ItemInterface::getTargetBundle	public	function	Return the target entity bundle id which this item is applicable.	1
ItemInterface::getTargetEntityType	public	function	Return the entity type id which this item is applicable.	1
ItemInterface::getType	public	function	Get the item type.	1
ItemInterface::getTypeLabel	public	function	Get the readable Type label.	1
ItemInterface::getTypes	public	function	Get all item types available.	1
ItemInterface::getVariables	public	function	Get the variables being used by the item.	1
ItemInterface::isContextDependent	public	function	Is the item context dependent?	1
ItemInterface::label	public	function	Get the item label. Overrides EntityInterface::label
ItemInterface::loadAllTags	public static	function	Load all Business Rule's tags.	1
ItemInterface::loadMultipleByType	public static	function	Load multiple items by type.	1
ItemInterface::setSetting	public	function	Set a value to the Item Settings.	1
ItemInterface::setTags	public	function	Set the tags value.	1
RefinableCacheableDependencyInterface::addCacheableDependency	public	function	Adds a dependency on an object: merges its cacheability metadata.	1
RefinableCacheableDependencyInterface::addCacheContexts	public	function	Adds cache contexts.	1
RefinableCacheableDependencyInterface::addCacheTags	public	function	Adds cache tags.	1
RefinableCacheableDependencyInterface::mergeCacheMaxAge	public	function	Merges the maximum age (in seconds) with the existing maximum age.	1
SynchronizableInterface::isSyncing	public	function	Returns whether this entity is being changed as part of a synchronization.	1
SynchronizableInterface::setSyncing	public	function	Sets the status of the synchronization flag.	1
ThirdPartySettingsInterface::getThirdPartyProviders	public	function	Gets the list of third parties that store information.	5
ThirdPartySettingsInterface::getThirdPartySetting	public	function	Gets the value of a third-party setting.	5
ThirdPartySettingsInterface::getThirdPartySettings	public	function	Gets all third-party settings of a given module.	5
ThirdPartySettingsInterface::setThirdPartySetting	public	function	Sets the value of a third-party setting.	5
ThirdPartySettingsInterface::unsetThirdPartySetting	public	function	Unsets a third-party setting.	5

You are here

interface ConditionInterface in Business Rules 8

Hierarchy

File

Namespace

Members

API Navigation