You are here

interface TransactionTypeInterface in Transaction 8

Provides an interface defining a type of transaction.

Hierarchy

Expanded class hierarchy of TransactionTypeInterface

All classes that implement TransactionTypeInterface

6 files declare their use of TransactionTypeInterface
ApplicableTransactionAccess.php in src/Access/ApplicableTransactionAccess.php
Transaction.php in src/Entity/Transaction.php
TransactionController.php in src/Controller/TransactionController.php
TransactionForm.php in src/Form/TransactionForm.php
TransactionType.php in src/Entity/TransactionType.php

... See full list

File

src/TransactionTypeInterface.php, line 11

Namespace

Drupal\transaction
View source
interface TransactionTypeInterface extends ConfigEntityInterface {

  /**
   * Standard post-save execution.
   */
  const EXECUTION_STANDARD = 0;

  /**
   * Immediate execution.
   */
  const EXECUTION_IMMEDIATE = 1;

  /**
   * Scheduled execution.
   */
  const EXECUTION_SCHEDULED = 2;

  /**
   * Ask for execution on save.
   */
  const EXECUTION_ASK = 3;

  /**
   * Returns the target entity type ID of this transaction.
   *
   * @return string
   *   The target entity type ID.
   */
  public function getTargetEntityTypeId();

  /**
   * Sets the target entity type ID of this transaction.
   *
   * @param string $entity_type_id
   *   The target entity type ID.
   *
   * @return \Drupal\transaction\TransactionTypeInterface
   *   The called transaction type.
   *
   * @deprecated in transaction:8.x-1.0 and is removed from transaction:8.x-2.0. Target entity type should be set only in constructor.
   */
  public function setTargetEntityTypeId($entity_type_id);

  /**
   * Gets the bundles of the target entity type.
   *
   * @param bool $applicable
   *   (optional) If TRUE, get all the applicable bundles if none set.
   *
   * @return string[]
   *   An array containing the applicable bundles. Empty array if none set and
   *   $applicable is FALSE (default), or all existent bundles for the target
   *   entity type if none was set and $applicable is TRUE.
   */
  public function getBundles($applicable = FALSE);

  /**
   * Gets the transactor plugin ID for this transaction type.
   *
   * @return string
   *   The transactor plugin ID.
   */
  public function getPluginId();

  /**
   * Set the transactor plugin.
   *
   * Calling this method reset the current plugin and its settings.
   *
   * @param string $plugin_id
   *   A string containing the flag type plugin ID.
   *
   * @return \Drupal\transaction\TransactionTypeInterface
   *   The called transaction type.
   */
  public function setPluginId($plugin_id);

  /**
   * Gets the plugin settings.
   *
   * @return array
   *   A key-value map of settings. Empty array if no settings.
   */
  public function getPluginSettings();

  /**
   * Sets the plugin settings.
   *
   * @param array $settings
   *   A key-value map with the settings.
   *
   * @return \Drupal\transaction\TransactionTypeInterface
   *   The called transaction type.
   */
  public function setPluginSettings(array $settings);

  /**
   * Gets the transactor plugin for this transaction type.
   *
   * @return \Drupal\transaction\TransactorPluginInterface
   *   The transactor plugin.
   */
  public function getPlugin();

  /**
   * Gets a transaction type additional option value.
   *
   * @param string $name
   *   The option to retrieve.
   * @param mixed $default_value
   *   Default value to return if no such option or it is empty.
   *
   * @return mixed
   *   The option current value or the default value if not available.
   */
  public function getOption($name, $default_value = NULL);

  /**
   * Gets a map of all defined options.
   *
   * @return array
   *   Current options keyed by it name. Empty array if no options set.
   */
  public function getOptions();

  /**
   * Sets a transaction type option.
   *
   * @param string $name
   *   The option to set.
   * @param mixed $value
   *   The new value.
   *
   * @return \Drupal\transaction\TransactionTypeInterface
   *   The called transaction type.
   */
  public function setOption($name, $value);

  /**
   * Sets the transaction type options, replacing the currently set.
   *
   * @param array $options
   *   The new set of options.
   *
   * @return \Drupal\transaction\TransactionTypeInterface
   *   The called transaction type.
   */
  public function setOptions(array $options);

  /**
   * Check if the type of transaction is applicable to a particular entity.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   The content entity to check.
   *
   * @return bool
   *   TRUE if transaction type is applicable to the given entity.
   */
  public function isApplicable(ContentEntityInterface $entity);

}

Members

Namesort descending 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::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
TransactionTypeInterface::EXECUTION_ASK constant Ask for execution on save.
TransactionTypeInterface::EXECUTION_IMMEDIATE constant Immediate execution.
TransactionTypeInterface::EXECUTION_SCHEDULED constant Scheduled execution.
TransactionTypeInterface::EXECUTION_STANDARD constant Standard post-save execution.
TransactionTypeInterface::getBundles public function Gets the bundles of the target entity type. 1
TransactionTypeInterface::getOption public function Gets a transaction type additional option value. 1
TransactionTypeInterface::getOptions public function Gets a map of all defined options. 1
TransactionTypeInterface::getPlugin public function Gets the transactor plugin for this transaction type. 1
TransactionTypeInterface::getPluginId public function Gets the transactor plugin ID for this transaction type. 1
TransactionTypeInterface::getPluginSettings public function Gets the plugin settings. 1
TransactionTypeInterface::getTargetEntityTypeId public function Returns the target entity type ID of this transaction. 1
TransactionTypeInterface::isApplicable public function Check if the type of transaction is applicable to a particular entity. 1
TransactionTypeInterface::setOption public function Sets a transaction type option. 1
TransactionTypeInterface::setOptions public function Sets the transaction type options, replacing the currently set. 1
TransactionTypeInterface::setPluginId public function Set the transactor plugin. 1
TransactionTypeInterface::setPluginSettings public function Sets the plugin settings. 1
TransactionTypeInterface::setTargetEntityTypeId Deprecated public function Sets the target entity type ID of this transaction. 1