You are here

interface BusinessRuleInterface in Business Rules 8

Same name and namespace in other branches
  1. 2.x src/BusinessRuleInterface.php \Drupal\business_rules\BusinessRuleInterface

Provides an interface for defining Rule entities.

Hierarchy

Expanded class hierarchy of BusinessRuleInterface

All classes that implement BusinessRuleInterface

1 file declares its use of BusinessRuleInterface
BusinessRule.php in src/Entity/BusinessRule.php

File

src/BusinessRuleInterface.php, line 10

Namespace

Drupal\business_rules
View source
interface BusinessRuleInterface extends ConfigEntityInterface {

  /**
   * Return all types of reactions events for business rules.
   *
   * @return array
   *   Array of event types.
   */
  public static function getEventTypes();

  /**
   * Load all Business Rule's tags.
   *
   * @return array
   *   Array of tags.
   */
  public static function loadAllTags();

  /**
   * Add one item on the Business Rule's items.
   *
   * @param \Drupal\business_rules\BusinessRulesItemObject $item
   *   The item to be added.
   */
  public function addItem(BusinessRulesItemObject $item);

  /**
   * Check if the item is on the same context as the Business Rule.
   *
   * @param \Drupal\business_rules\BusinessRulesItemObject $itemObject
   *   The business rule object.
   *
   * @return bool
   *   If the item is on the same context as the business rule.
   */
  public function checkItemContext(BusinessRulesItemObject $itemObject);

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

  /**
   * Get the current Business Rule's actions.
   *
   * @return array
   *   Array of actions.
   */
  public function getActions();

  /**
   * Get the current Business Rule's conditions.
   *
   * @return array
   *   Array of conditions.
   */
  public function getConditions();

  /**
   * The rule description.
   *
   * @return string
   *   The business rule description.
   */
  public function getDescription();

  /**
   * Get one Business Rule item.
   *
   * @param string $item_id
   *   The item id.
   *
   * @return BusinessRulesItemObject
   *   The item.
   */
  public function getItem($item_id);

  /**
   * Get the max weight for the Business Rule's items.
   *
   * @return int
   *   The max weight.
   */
  public function getItemMaxWeight();

  /**
   * The Business rule's items.
   *
   * @return array
   *   Array of BusinessRulesItemObject.
   */
  public function getItems();

  /**
   * The trigger that will start the rule.
   *
   * @return string
   *   The reacts on event id for the rule.
   */
  public function getReactsOn();

  /**
   * The label of the trigger that will start the rule.
   *
   * @var string
   *   The reacts on event label for the rule.
   */
  public function getReactsOnLabel();

  /**
   * Get the tags value.
   *
   * @return array
   *   The tags value.
   */
  public function getTags();

  /**
   * The target entity bundle id which this rule is applicable.
   *
   * @var string
   *   Context: The rule target bundle id.
   */
  public function getTargetBundle();

  /**
   * The label of the target entity bundle id which this rule is applicable.
   *
   * @var string
   *   Context: The rule target bundle label.
   */
  public function getTargetBundleLabel();

  /**
   * The entity type id which this rule is applicable.
   *
   * @var string
   *   Context: The rule target entity type id.
   */
  public function getTargetEntityType();

  /**
   * The label of the entity type id which this rule is applicable.
   *
   * @var string
   *   Context: The rule target entity type label.
   */
  public function getTargetEntityTypeLabel();

  /**
   * Returns TRUE if the BusinessRule is enabled and FALSE if not.
   *
   * @return bool
   *   If the rule is enabled.
   */
  public function isEnabled();

  /**
   * Remove one item from the Business rule's items.
   *
   * @param \Drupal\business_rules\BusinessRulesItemObject $item
   *   The item to be removed.
   */
  public function removeItem(BusinessRulesItemObject $item);

  /**
   * Set the enabled parameter.
   *
   * @param bool $status
   *   Set the enabled status: true|false.
   */
  public function setEnabled($status);

  /**
   * Set the tags value.
   *
   * @param array $tags
   *   The tags.
   */
  public function setTags(array $tags);

}

Members

Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. 9
BusinessRuleInterface::addItem public function Add one item on the Business Rule's items. 1
BusinessRuleInterface::checkItemContext public function Check if the item is on the same context as the Business Rule. 1
BusinessRuleInterface::filterContextAvailableItems public function Return a list of Conditions|Actions compatible with the Rule. 1
BusinessRuleInterface::getActions public function Get the current Business Rule's actions. 1
BusinessRuleInterface::getConditions public function Get the current Business Rule's conditions. 1
BusinessRuleInterface::getDescription public function The rule description. 1
BusinessRuleInterface::getEventTypes public static function Return all types of reactions events for business rules. 1
BusinessRuleInterface::getItem public function Get one Business Rule item. 1
BusinessRuleInterface::getItemMaxWeight public function Get the max weight for the Business Rule's items. 1
BusinessRuleInterface::getItems public function The Business rule's items. 1
BusinessRuleInterface::getReactsOn public function The trigger that will start the rule. 1
BusinessRuleInterface::getReactsOnLabel public function The label of the trigger that will start the rule. 1
BusinessRuleInterface::getTags public function Get the tags value. 1
BusinessRuleInterface::getTargetBundle public function The target entity bundle id which this rule is applicable. 1
BusinessRuleInterface::getTargetBundleLabel public function The label of the target entity bundle id which this rule is applicable. 1
BusinessRuleInterface::getTargetEntityType public function The entity type id which this rule is applicable. 1
BusinessRuleInterface::getTargetEntityTypeLabel public function The label of the entity type id which this rule is applicable. 1
BusinessRuleInterface::isEnabled public function Returns TRUE if the BusinessRule is enabled and FALSE if not. 1
BusinessRuleInterface::loadAllTags public static function Load all Business Rule's tags. 1
BusinessRuleInterface::removeItem public function Remove one item from the Business rule's items. 1
BusinessRuleInterface::setEnabled public function Set the enabled parameter. 1
BusinessRuleInterface::setTags public function Set the tags value. 1
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
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::label public function Gets the label of the entity. 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
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