interface ItemInterface in Business Rules 2.x

Same name and namespace in other branches

8 src/ItemInterface.php \Drupal\business_rules\ItemInterface

Class BusinessRuleItemInterface.

@package Drupal\business_rules

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

Expanded class hierarchy of ItemInterface

All classes that implement ItemInterface

47 files declare their use of ItemInterface

ActionSet.php in src/Plugin/BusinessRulesAction/ActionSet.php
AddNodeToGroupAction.php in modules/br_group/src/Plugin/BusinessRulesAction/AddNodeToGroupAction.php
AddRoleToUser.php in src/Plugin/BusinessRulesAction/AddRoleToUser.php
AddUserToGroupAction.php in modules/br_group/src/Plugin/BusinessRulesAction/AddUserToGroupAction.php
AssignRoleToUserAction.php in modules/br_group/src/Plugin/BusinessRulesAction/AssignRoleToUserAction.php

... See full list

File

src/ItemInterface.php, line 12

Namespace

Drupal\business_rules

View source

interface ItemInterface extends ConfigEntityInterface {

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

  /**
   * Load multiple items by type.
   *
   * @param string $type
   *   The item type. i.e. The plugin id.
   * @param array|null $ids
   *   The items ids.
   *
   * @return array
   *   Array with the matched items.
   */
  public static function loadMultipleByType($type, array $ids = NULL);

  /**
   * Get the Item type translated. Action|Condition.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The translates item type label.
   */
  public function getBusinessRuleItemTranslatedType();

  /**
   * Get the Item type: action|condition.
   *
   * @return string
   *   The item type: action|condition.
   */
  public function getBusinessRuleItemType();

  /**
   * Get the item description.
   *
   * @return string
   *   The item description.
   */
  public function getDescription();

  /**
   * Get the reactsOn ids applicable for the item.
   *
   * @return array
   *   Context: Array of reactsOn ids applicable for the item.
   */
  public function getReactOnEvents();

  /**
   * Return the item settings.
   *
   * @param string $settingId
   *   the settings ID for the config entity.
   *
   * @return array|string
   *   The item settings.
   */
  public function getSettings($settingId = '');

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

  /**
   * Return the target entity bundle id which this item is applicable.
   *
   * @return string
   *   The target entity bundle id which this item is applicable.
   */
  public function getTargetBundle();

  /**
   * Return the entity type id which this item is applicable.
   *
   * @return string
   *   The entity type id which this item is applicable.
   */
  public function getTargetEntityType();

  /**
   * Get the item type.
   *
   * @return string
   *   The item type
   */
  public function getType();

  /**
   * Get the readable Type label.
   *
   * @return string
   *   The readable Type label.
   */
  public function getTypeLabel();

  /**
   * Get all item types available.
   *
   * @return array
   *   All item types available
   */
  public function getTypes();

  /**
   * Get the variables being used by the item.
   *
   * @return \Drupal\business_rules\VariablesSet
   *   The variables being used by the item.
   */
  public function getVariables();

  /**
   * Is the item context dependent?
   *
   * @return bool
   *   True if the item is context dependent, false if not.
   */
  public function isContextDependent();

  /**
   * Get the item label.
   *
   * @return string
   *   The item label.
   */
  public function label();

  /**
   * Set a value to the Item Settings.
   *
   * @param string $settingId
   *   The setting id.
   * @param mixed $value
   *   The value to be set on Item settings.
   *
   * @throws \Exception
   */
  public function setSetting($settingId, $value);

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

}

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
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::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::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 ItemInterface in Business Rules 2.x

Hierarchy

File

Namespace

Members

API Navigation