class TransactionType in Transaction 8

Provides a type of transaction.

Plugin annotation


@ConfigEntityType(
  id = "transaction_type",
  label = @Translation("Transaction type"),
  label_singular = @Translation("Transaction type"),
  label_plural = @Translation("Transaction types"),
  label_count = @PluralTranslation(
    singular = "@count transaction type",
    plural = "@count transaction types",
  ),
  admin_permission = "administer transaction types",
  handlers = {
    "storage" = "Drupal\transaction\TransactionTypeStorage",
    "list_builder" = "Drupal\transaction\TransactionTypeListBuilder",
    "form" = {
      "add" = "Drupal\transaction\Form\TransactionTypeAddForm",
      "edit" = "Drupal\transaction\Form\TransactionTypeEditForm",
      "delete" = "Drupal\transaction\Form\TransactionTypeDeleteForm",
    },
  },
  config_prefix = "type",
  bundle_of = "transaction",
  entity_keys = {
    "id" = "id",
    "label" = "label",
  },
  links = {
    "add-form" = "/admin/config/workflow/transaction/add/{target_entity_type}/{transactor}",
    "edit-form" = "/admin/config/workflow/transaction/edit/{transaction_type}",
    "delete-form" = "/admin/config/workflow/transaction/delete/{transaction_type}",
    "collection" = "/admin/config/workflow/transaction",
  },
  config_export = {
    "id",
    "label",
    "target_entity_type",
    "transactor",
    "bundles",
    "options",
  },
)

Hierarchy

class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
  - class \Drupal\Core\Config\Entity\ConfigEntityBundleBase
    class \Drupal\transaction\Entity\TransactionType implements TransactionTypeInterface

Expanded class hierarchy of TransactionType

4 files declare their use of TransactionType

BalanceTransactionTest.php in tests/src/Kernel/BalanceTransactionTest.php
GenericTransactionTest.php in tests/src/Kernel/GenericTransactionTest.php
TransactionAdminTest.php in tests/src/Functional/TransactionAdminTest.php
TransactionTypeFormBase.php in src/Form/TransactionTypeFormBase.php

File

src/Entity/TransactionType.php, line 55

Namespace

Drupal\transaction\Entity

View source

class TransactionType extends ConfigEntityBundleBase implements TransactionTypeInterface {

  /**
   * The transaction type ID.
   *
   * @var string
   */
  protected $id;

  /**
   * The transaction type label.
   *
   * @var string
   */
  protected $label;

  /**
   * The target entity type ID.
   *
   * @var string
   */
  protected $target_entity_type;

  /**
   * The transactor plugin ID and its settings.
   *
   * @var string[]
   */
  protected $transactor;

  /**
   * Applicable bundles of the target entity type.
   *
   * @var string[]
   */
  protected $bundles = [];

  /**
   * Additional options.
   *
   * @var array
   */
  protected $options = [];

  /**
   * A collection to store the transactor plugin.
   *
   * @var \Drupal\Core\Plugin\DefaultSingleLazyPluginCollection
   */
  protected $pluginCollection;

  /**
   * {@inheritdoc}
   */
  public function getTargetEntityTypeId() {
    return $this->target_entity_type;
  }

  /**
   * {@inheritdoc}
   */
  public function setTargetEntityTypeId($entity_type_id) {
    $this->target_entity_type = $entity_type_id;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getBundles($applicable = FALSE) {
    $bundles = $this->bundles;
    if (empty($bundles) && $applicable) {

      // If the setting is empty, return all bundle names for the target entity
      // type.

      /** @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface $bundle_info_service */
      $bundle_info_service = \Drupal::service('entity_type.bundle.info');
      $bundle_info = $bundle_info_service
        ->getBundleInfo($this->target_entity_type);
      $bundles = array_keys($bundle_info);
    }
    return $bundles;
  }

  /**
   * Single plugin collection that encapsulates the transactor plugin.
   *
   * @return \Drupal\Core\Plugin\DefaultSingleLazyPluginCollection
   *   The transactor plugin collection.
   */
  protected function getPluginCollection() {
    if (!$this->pluginCollection) {

      // Empty configuration, to be set from the transaction type form.
      $this->pluginCollection = new DefaultSingleLazyPluginCollection(\Drupal::service('plugin.manager.transaction.transactor'), $this->transactor['id'], $this->transactor['settings']);
    }
    return $this->pluginCollection;
  }

  /**
   * {@inheritdoc}
   */
  public function getPluginId() {
    return isset($this->transactor['id']) ? $this->transactor['id'] : NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function setPluginId($plugin_id) {
    $this->transactor['id'] = $plugin_id;
    $this->transactor['settings'] = [];
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getPluginSettings() {
    return isset($this->transactor['settings']) ? $this->transactor['settings'] : [];
  }

  /**
   * {@inheritdoc}
   */
  public function setPluginSettings(array $settings) {
    $this->transactor['settings'] = $settings;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getPlugin() {
    $plugin = NULL;
    if ($plugin_id = $this
      ->getPluginId()) {
      $plugin = $this
        ->getPluginCollection()
        ->get($plugin_id);
    }
    return $plugin;
  }

  /**
   * {@inheritdoc}
   */
  public function getOption($name, $default_value = NULL) {
    return isset($this->options[$name]) ? $this->options[$name] : $default_value;
  }

  /**
   * {@inheritdoc}
   */
  public function getOptions() {
    return $this->options;
  }

  /**
   * {@inheritdoc}
   */
  public function setOption($name, $value) {
    $this->options[$name] = $value;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function setOptions(array $options) {
    $this->options = $options;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function isApplicable(ContentEntityInterface $entity) {
    if ($result = in_array($entity
      ->bundle(), $this
      ->getBundles(TRUE))) {
      $result = $this
        ->getPlugin()
        ->isApplicable($entity, $this);
    }
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function preSave(EntityStorageInterface $storage) {
    parent::preSave($storage);

    // Sort bundles.
    $bundles = array_filter($this
      ->get('bundles'));
    sort($bundles);
    $this
      ->set('bundles', $bundles);
  }

  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE) {
    parent::postSave($storage, $update);

    // Following only applies to transaction type creation outside config sync.
    if ($update || \Drupal::isConfigSyncing()) {
      return;
    }

    // Create the list view display mode if it does not exist.
    $entity_display_id = 'transaction.' . $this
      ->id() . '.list';
    $entity_view_display_storage = $this
      ->entityTypeManager()
      ->getStorage('entity_view_display');
    if ($entity_view_display_storage
      ->load($entity_display_id)) {
      return;
    }

    /** @var \Drupal\Core\Entity\Display\EntityViewDisplayInterface $list_display_mode */
    $list_display_mode = $entity_view_display_storage
      ->create([
      'id' => $entity_display_id,
      'targetEntityType' => 'transaction',
      'bundle' => $this
        ->id(),
      'mode' => 'list',
      'status' => TRUE,
    ]);

    // Hide labels for all components in list view mode, table header used
    // instead.
    foreach ($list_display_mode
      ->getComponents() as $name => $component) {
      if (isset($component['label']) && $component['label'] != 'hidden') {
        $component['label'] = 'hidden';
        $list_display_mode
          ->setComponent($name, $component);
      }
    }
    $list_display_mode
      ->save();
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {

    // Add dependency on the target entity type provider.
    $this
      ->addDependency('module', $this
      ->entityTypeManager()
      ->getDefinition($this->target_entity_type)
      ->getProvider());

    // Add dependency on the plugin provider.
    $this
      ->calculatePluginDependencies($this
      ->getPlugin());
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  protected function urlRouteParameters($rel) {
    $uri_route_parameters = parent::urlRouteParameters($rel);
    if ($rel === 'add-form') {
      $uri_route_parameters['target_entity_type'] = $this
        ->getTargetEntityTypeId();
      $uri_route_parameters['transactor'] = $this
        ->getPluginId();
    }
    return $uri_route_parameters;
  }

  /**
   * {@inheritdoc}
   */
  public function set($property_name, $value) {
    if ($property_name === 'bundles') {

      // Sanitize values for bundles.
      $clean_value = [];
      if (is_array($value)) {
        foreach ($value as $item) {
          if (!empty($item) && is_string($item)) {
            $clean_value[] = $item;
          }
        }
      }
      $value = $clean_value;
    }
    return parent::set($property_name, $value);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
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	Information maintained by Drupal core about configuration.
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::link	public	function	Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval	7
ConfigEntityBase::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete	8
ConfigEntityBase::save	public	function	Saves an entity permanently. Overrides EntityBase::save	1
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::url	public	function	Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo	public	function	Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct	public	function	Constructs an Entity object. Overrides EntityBase::__construct	10
ConfigEntityBase::__sleep	public	function	Overrides EntityBase::__sleep	4
ConfigEntityBundleBase::deleteDisplays	protected	function	Deletes display if a bundle is deleted.
ConfigEntityBundleBase::loadDisplays	protected	function	Returns view or form displays for this bundle.
ConfigEntityBundleBase::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked. Overrides EntityBase::postDelete	2
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function	Aliased as: traitSleep	1
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::delete	public	function	Deletes an entity permanently. Overrides EntityInterface::delete	2
EntityBase::enforceIsNew	public	function	Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated	protected	function	Gets the entity manager.
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::postLoad	public static	function	Acts on loaded entities. Overrides EntityInterface::postLoad	2
EntityBase::preCreate	public static	function	Changes the values of an entity before it is created. Overrides EntityInterface::preCreate	5
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::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
TransactionType::$bundles	protected	property	Applicable bundles of the target entity type.
TransactionType::$id	protected	property	The transaction type ID.
TransactionType::$label	protected	property	The transaction type label.
TransactionType::$options	protected	property	Additional options.
TransactionType::$pluginCollection	protected	property	A collection to store the transactor plugin.
TransactionType::$target_entity_type	protected	property	The target entity type ID.
TransactionType::$transactor	protected	property	The transactor plugin ID and its settings.
TransactionType::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
TransactionType::getBundles	public	function	Gets the bundles of the target entity type. Overrides TransactionTypeInterface::getBundles
TransactionType::getOption	public	function	Gets a transaction type additional option value. Overrides TransactionTypeInterface::getOption
TransactionType::getOptions	public	function	Gets a map of all defined options. Overrides TransactionTypeInterface::getOptions
TransactionType::getPlugin	public	function	Gets the transactor plugin for this transaction type. Overrides TransactionTypeInterface::getPlugin
TransactionType::getPluginCollection	protected	function	Single plugin collection that encapsulates the transactor plugin.
TransactionType::getPluginId	public	function	Gets the transactor plugin ID for this transaction type. Overrides TransactionTypeInterface::getPluginId
TransactionType::getPluginSettings	public	function	Gets the plugin settings. Overrides TransactionTypeInterface::getPluginSettings
TransactionType::getTargetEntityTypeId	public	function	Returns the target entity type ID of this transaction. Overrides TransactionTypeInterface::getTargetEntityTypeId
TransactionType::isApplicable	public	function	Check if the type of transaction is applicable to a particular entity. Overrides TransactionTypeInterface::isApplicable
TransactionType::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides ConfigEntityBundleBase::postSave
TransactionType::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBundleBase::preSave
TransactionType::set	public	function	Sets the value of a property. Overrides ConfigEntityBase::set
TransactionType::setOption	public	function	Sets a transaction type option. Overrides TransactionTypeInterface::setOption
TransactionType::setOptions	public	function	Sets the transaction type options, replacing the currently set. Overrides TransactionTypeInterface::setOptions
TransactionType::setPluginId	public	function	Set the transactor plugin. Overrides TransactionTypeInterface::setPluginId
TransactionType::setPluginSettings	public	function	Sets the plugin settings. Overrides TransactionTypeInterface::setPluginSettings
TransactionType::setTargetEntityTypeId	public	function	Sets the target entity type ID of this transaction. Overrides TransactionTypeInterface::setTargetEntityTypeId
TransactionType::urlRouteParameters	protected	function	Gets an array of placeholders for this entity. Overrides EntityBase::urlRouteParameters
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.

You are here

class TransactionType in Transaction 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation