You are here

Home » API reference » Transaction 8 » TransactionTypeFormBase.php

abstract class TransactionTypeFormBase in Transaction 8

Base form for transaction type forms.

Hierarchy

Expanded class hierarchy of TransactionTypeFormBase

File

src/Form/TransactionTypeFormBase.php, line 18

Namespace

Drupal\transaction\Form
View source 
abstract class TransactionTypeFormBase extends BundleEntityFormBase {

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

  /**
   * The entity type bundle info.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $bundleInfo;

  /**
   * Constructs the TransactionTypeFormBase object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
   *   The translation manager.
   * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $bundle_info
   *   The entity type bundle info.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, TranslationInterface $string_translation, EntityTypeBundleInfoInterface $bundle_info) {
    $this->entityTypeManager = $entity_type_manager;
    $this->stringTranslation = $string_translation;
    $this->bundleInfo = $bundle_info;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('string_translation'), $container
      ->get('entity_type.bundle.info'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);

    /** @var \Drupal\transaction\TransactionTypeInterface $transaction_type */
    $transaction_type = $this->entity;
    $form['label'] = [
      '#title' => $this
        ->t('Name'),
      '#type' => 'textfield',
      '#default_value' => $transaction_type
        ->label(),
      '#description' => $this
        ->t('The human-readable name of this transaction type.'),
      '#maxlength' => 255,
      '#required' => TRUE,
      '#size' => 30,
    ];
    $form['id'] = [
      '#type' => 'machine_name',
      '#default_value' => $transaction_type
        ->id(),
      '#maxlength' => EntityTypeInterface::BUNDLE_MAX_LENGTH,
      '#machine_name' => [
        'exists' => [
          TransactionType::class,
          'load',
        ],
        'source' => [
          'label',
        ],
      ],
      '#description' => $this
        ->t('A unique machine-readable name for this transaction type. It must only contain lowercase letters, numbers, and underscores.'),
    ];

    // Set the target entity type from request arguments on creation.
    if ($transaction_type
      ->isNew()) {
      $transaction_type
        ->setTargetEntityTypeId($this
        ->getRequest()
        ->get('target_entity_type'));
    }

    // Applicable bundles.
    $target_entity_type = $this->entityTypeManager
      ->getDefinition($transaction_type
      ->getTargetEntityTypeId());
    if ($target_entity_type
      ->getBundleEntityType()) {
      $bundles = [];
      $definitions = $this->bundleInfo
        ->getBundleInfo($target_entity_type
        ->id());
      foreach ($definitions as $bundle_id => $bundle_metadata) {
        $bundles[$bundle_id] = $bundle_metadata['label'];
      }
      if (count($bundles)) {
        asort($bundles);
        $form['bundles'] = [
          '#type' => 'checkboxes',
          '#title' => $this
            ->t('Bundles'),
          '#description' => $this
            ->t('Bundles of the target entity type where this transaction type is applicable. Leave empty to apply to all bundles.'),
          '#options' => $bundles,
          '#default_value' => $transaction_type
            ->getBundles(),
        ];
      }
    }

    // Set the transactor plugin id from request arguments on creation.
    if ($transaction_type
      ->isNew()) {
      $transaction_type
        ->setPluginId($this
        ->getRequest()
        ->get('transactor'));
    }

    // General options.
    $form['options'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Options'),
      '#open' => TRUE,
      '#tree' => FALSE,
      '#weight' => 50,
    ];

    // Add transaction local task (tab) to target entity.
    $form['options']['execution'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Execution control'),
      '#default_value' => $transaction_type
        ->getOption('execution', TransactionTypeInterface::EXECUTION_STANDARD),
      '#options' => [
        TransactionTypeInterface::EXECUTION_STANDARD => $this
          ->t('Leave as pending'),
        TransactionTypeInterface::EXECUTION_IMMEDIATE => $this
          ->t('Immediate execution'),
        TransactionTypeInterface::EXECUTION_ASK => $this
          ->t('Ask user'),
      ],
    ];
    $form['options']['execution'][TransactionTypeInterface::EXECUTION_STANDARD]['#description'] = $this
      ->t('The new transaction can be executed only after its creation.');
    $form['options']['execution'][TransactionTypeInterface::EXECUTION_IMMEDIATE]['#description'] = $this
      ->t('The transaction will be executed automatically right after its creation.');
    $form['options']['execution'][TransactionTypeInterface::EXECUTION_ASK]['#description'] = $this
      ->t('Let the user choose how the new transaction will be executed in the transaction form.');

    // Transaction list local task in the target entity.
    $form['options']['local_task'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Add a local task (tab) to access the transaction list in the target entity'),
      '#description' => $this
        ->t('The tab will be labeled with the transaction type name. Disable if you have your own views based transaction list.'),
      '#default_value' => !empty($transaction_type
        ->getOption('local_task')),
    ];

    // Add transactor settings.
    $form = $transaction_type
      ->getPlugin()
      ->buildConfigurationForm($form, $form_state);
    return $this
      ->protectBundleIdElement($form);
  }

  /**
   * {@inheritdoc}
   */
  protected function actions(array $form, FormStateInterface $form_state) {
    $actions = parent::actions($form, $form_state);
    $actions['submit']['#value'] = $this
      ->t('Save transaction type');
    return $actions;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);

    /** @var \Drupal\transaction\TransactionTypeInterface $transaction_type */
    $transaction_type = $this->entity;
    $id = trim($form_state
      ->getValue('id'));

    // '0' is invalid, to safe empty check.
    if ($id == '0') {
      $form_state
        ->setErrorByName('id', $this
        ->t("Invalid machine-readable name. Enter a name other than %invalid.", [
        '%invalid' => $id,
      ]));
    }
    $transaction_type
      ->getPlugin()
      ->validateConfigurationForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function save(array $form, FormStateInterface $form_state) {

    /** @var \Drupal\transaction\TransactionTypeInterface $transaction_type */
    $transaction_type = $this->entity;

    // Process options.
    $this
      ->saveOptions($form, $form_state);

    // Plugin needs that the transaction type is saved to create new fields.
    $status = $transaction_type
      ->isNew() ? $transaction_type
      ->save() : SAVED_UPDATED;

    // Set the transactor's config.
    $transaction_type
      ->getPlugin()
      ->submitConfigurationForm($form, $form_state);

    // Update the transaction type.
    $transaction_type
      ->save();

    // Messages.
    $t_args = [
      '%label' => $transaction_type
        ->label(),
      '@transactor' => $transaction_type
        ->getPluginId(),
      '@target' => $transaction_type
        ->getTargetEntityTypeId(),
    ];
    $logger_args = $t_args + [
      'link' => $transaction_type
        ->toLink($this
        ->t('Edit'), 'edit-form')
        ->toString(),
    ];
    if ($status == SAVED_UPDATED) {
      $this
        ->messenger()
        ->addStatus($this
        ->t('Transaction type %label has been updated.', $t_args));
      $this
        ->logger('transaction')
        ->notice('Transaction type %label has been updated.', $logger_args);
    }
    else {
      $this
        ->messenger()
        ->addStatus($this
        ->t('Transaction type %label has been added.', $t_args));
      $this
        ->logger('transaction')
        ->notice('New transaction type %label with transactor @transactor and target entity type @target has been added.', $logger_args);
    }
    $form_state
      ->setRedirectUrl($transaction_type
      ->toUrl('collection'));
  }

  /**
   * Process submitted options.
   *
   * @param array $form
   *   The form definition.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   */
  protected function saveOptions(array $form, FormStateInterface $form_state) {

    /** @var \Drupal\transaction\TransactionTypeInterface $transaction_type */
    $transaction_type = $this->entity;
    $new_options = [];
    foreach (isset($form['options']) ? array_keys($form['options']) : [] as $option_key) {
      if ($value = $form_state
        ->getValue($option_key)) {
        $new_options[$option_key] = $value;
      }
    }
    $transaction_type
      ->setOptions($new_options);
  }

  /**
   * {@inheritdoc}
   */
  public function delete(array $form, FormStateInterface $form_state) {
    $form_state
      ->setRedirectUrl($this->entity
      ->toUrl('collection'));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BundleEntityFormBase::protectBundleIdElement protected function Protects the bundle entity's ID property's form element against changes.
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
EntityForm::$entity protected property The entity being used by this form. 7
EntityForm::$moduleHandler protected property The module handler service.
EntityForm::$operation protected property The name of the current operation.
EntityForm::$privateEntityManager private property The entity manager.
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity 2
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties 7
EntityForm::form public function Gets the actual form array to be built. 30
EntityForm::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId 5
EntityForm::getEntity public function Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch 1
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 10
EntityForm::getOperation public function Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::init protected function Initialize the form state and the entity before the first form build. 3
EntityForm::prepareEntity protected function Prepares the entity object before the form is built first. 3
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityManager public function Sets the entity manager for this form. Overrides EntityFormInterface::setEntityManager
EntityForm::setEntityTypeManager public function Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::submitForm public function This is the default entity object builder function. It is called before any other submit handler to build the new entity object to be used by the following submit handlers. At this point of the form workflow the entity is validated and the form state… Overrides FormInterface::submitForm 17
EntityForm::__get public function
EntityForm::__set public function
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.
TransactionTypeFormBase::$bundleInfo protected property The entity type bundle info.
TransactionTypeFormBase::$entityTypeManager protected property The entity type manager. Overrides EntityForm::$entityTypeManager
TransactionTypeFormBase::actions protected function Returns an array of supported actions for the current entity form. Overrides EntityForm::actions 1
TransactionTypeFormBase::buildForm public function Form constructor. Overrides EntityForm::buildForm 1
TransactionTypeFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create
TransactionTypeFormBase::delete public function
TransactionTypeFormBase::save public function Form submission handler for the 'save' action. Overrides EntityForm::save
TransactionTypeFormBase::saveOptions protected function Process submitted options.
TransactionTypeFormBase::validateForm public function Form validation handler. Overrides FormBase::validateForm
TransactionTypeFormBase::__construct public function Constructs the TransactionTypeFormBase object.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.