class TransactionCreate in Transaction 8

Provides the transaction create action.

Plugin annotation


@RulesAction(
  id = "transaction_create",
  deriver = "Drupal\transaction\Plugin\RulesAction\TransactionCreateDeriver",
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\rules\Core\RulesActionBase implements RulesActionInterface uses ContextProviderTrait, ConfigurationAccessControlTrait, ExecutablePluginTrait
    class \Drupal\transaction\Plugin\RulesAction\TransactionCreate implements ContainerFactoryPluginInterface

Expanded class hierarchy of TransactionCreate

File

src/Plugin/RulesAction/TransactionCreate.php, line 19

Namespace

Drupal\transaction\Plugin\RulesAction

View source

class TransactionCreate extends RulesActionBase implements ContainerFactoryPluginInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * A logger instance.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

  /**
   * Constructs an TransactionCreate object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin ID for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Psr\Log\LoggerInterface $logger
   *   A logger instance.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, LoggerInterface $logger) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_type_manager;
    $this->logger = $logger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'), $container
      ->get('logger.factory')
      ->get('rules'));
  }

  /**
   * {@inheritdoc}
   */
  public function refineContextDefinitions(array $selected_data) {
    if ($transaction_type_id = $this
      ->getContextValue('transaction_type_id')) {
      $data_type = 'entity:transaction:' . $transaction_type_id;
      $this->pluginDefinition['provides']['transaction']
        ->setDataType($data_type);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function execute() {
    $values = $this
      ->getContextValues();

    /** @var \Drupal\transaction\TransactionTypeInterface $transaction_type */
    if (!($transaction_type = $this->entityTypeManager
      ->getStorage('transaction_type')
      ->load($values['transaction_type_id']))) {

      // Transaction type not found.
      $this->logger
        ->error('Transaction type @type not found in action rule %rule', [
        '@type' => $values['transaction_type_id'],
        '%rule' => $this
          ->getLabelValue(),
      ]);
      return;
    }

    // Ensure that the transaction type has this transactor.
    if ($transaction_type
      ->getPluginId() != $this
      ->getDerivativeId()) {
      $this->logger
        ->error('Mismatch transactor in rule %rule for transaction type %type', [
        '%rule' => $this
          ->getLabelValue(),
        '%type' => $transaction_type
          ->label(),
      ]);
      return;
    }

    // Check if the transaction type is applicable to the given target entity.
    $target_entity = $values['target_entity'];
    if (!$transaction_type
      ->isApplicable($target_entity)) {
      $this->logger
        ->error('Transaction type %type not applicable to the target entity %target', [
        '%type' => $transaction_type
          ->label(),
        '%target' => $target_entity
          ->label(),
      ]);
      return;
    }

    // Create the transaction.

    /** @var \Drupal\transaction\TransactionInterface $transaction */
    $transaction = $this->entityTypeManager
      ->getStorage('transaction')
      ->create([
      'type' => $transaction_type
        ->id(),
      'target_entity' => $target_entity,
    ]);

    // Set the operation.
    if (!empty($values['operation_id'])) {
      $transaction
        ->setOperation($values['operation_id']);
    }

    // Set field values.
    $settings = $transaction_type
      ->getPluginSettings();
    foreach ([
      'transaction',
      'target',
    ] as $field_group) {
      $entity = $field_group == 'transaction' ? $transaction : $target_entity;
      $field_prefix = $field_group . '_field_';
      foreach ($values as $key => $value) {
        if (strpos($key, $field_prefix) === 0) {
          $transactor_field_name = substr($key, strlen($field_prefix));
          if (!empty($settings[$transactor_field_name]) && $entity
            ->hasField($settings[$transactor_field_name])) {
            $entity
              ->get($settings[$transactor_field_name])
              ->setValue($value);
          }
        }
      }
    }
    $this
      ->setProvidedValue('transaction', $transaction);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurationAccessControlTrait::checkConfigurationAccess	public	function	Checks configuration permission.
ContextAwarePluginBase::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated	private	property	Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginBase::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	9
ContextAwarePluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	7
ContextAwarePluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	4
ContextAwarePluginBase::getContext	public	function	This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition	public	function	Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions	public	function	Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts	public	function	Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValues	public	function	Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext	public	function	Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue	public	function	Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts	public	function	Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get	public	function	Implements magic __get() method.
ContextProviderTrait::$providedContext	protected	property	The data objects that are provided by this plugin.
ContextProviderTrait::getProvidedContext	public	function
ContextProviderTrait::getProvidedContextDefinition	public	function
ContextProviderTrait::getProvidedContextDefinitions	public	function
ContextProviderTrait::setProvidedValue	public	function
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		1
DependencySerializationTrait::__wakeup	public	function		2
ExecutablePluginTrait::getLabelValue	protected	function	Get the translated label from the plugin definition.
ExecutablePluginTrait::summary	public	function	Get the translated summary from the label annotation.	4
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
RulesActionBase::$configuration	protected	property	The plugin configuration. Overrides PluginBase::$configuration
RulesActionBase::access	public	function	Checks object access. Overrides RulesActionInterface::access
RulesActionBase::assertMetadata	public	function	Asserts additional metadata for the selected data. Overrides ContextAwarePluginInterface::assertMetadata
RulesActionBase::autoSaveContext	public	function	Returns a list of context names that should be auto-saved after execution. Overrides RulesActionInterface::autoSaveContext	14
RulesActionBase::calculateDependencies	public	function	@todo this documentation is not actually inherited from any interface. Do we need this empty implementation?
RulesActionBase::defaultConfiguration	public	function	@todo this documentation is not actually inherited from any interface. Do we need this empty implementation?
RulesActionBase::executeMultiple	public	function	@todo this documentation is not actually inherited from any interface. Do we need this empty implementation?
RulesActionBase::getConfiguration	public	function	@todo this documentation is not actually inherited from any interface.
RulesActionBase::getContextValue	public	function	Gets the value for a defined context. Overrides ContextAwarePluginBase::getContextValue
RulesActionBase::setConfiguration	public	function	@todo this documentation is not actually inherited from any interface.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TransactionCreate::$entityTypeManager	protected	property	The entity type manager.
TransactionCreate::$logger	protected	property	A logger instance.
TransactionCreate::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
TransactionCreate::execute	public	function	Executes the plugin. Overrides RulesActionBase::execute
TransactionCreate::refineContextDefinitions	public	function	Refines used and provided context definitions based upon context values. Overrides RulesActionBase::refineContextDefinitions
TransactionCreate::__construct	public	function	Constructs an TransactionCreate object. Overrides ContextAwarePluginBase::__construct
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2

You are here

class TransactionCreate in Transaction 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation