You are here

Home » API reference » Transaction 8 » TransactionTypeCreationForm.php

class TransactionTypeCreationForm in Transaction 8

Provides the transaction type creation form.

The target entity type and the transaction plugin cannot be changed once a transaction type is created, so we need a creation page to select this two paramenters when creating a new transaction type.

Hierarchy

Expanded class hierarchy of TransactionTypeCreationForm

See also

\Drupal\transaction\TransactionTypeInterface

1 string reference to 'TransactionTypeCreationForm'
transaction.routing.yml in ./transaction.routing.yml
transaction.routing.yml

File

src/Form/TransactionTypeCreationForm.php, line 21

Namespace

Drupal\transaction\Form
View source 
class TransactionTypeCreationForm extends FormBase {

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

  /**
   * The transactor plugin manager.
   *
   * @var \Drupal\transaction\TransactorPluginManager
   */
  protected $transactorManager;

  /**
   * Constructs a new transaction type creation form.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\transaction\TransactorPluginManager $transactor_manager
   *   The transactor plugin manager.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, TransactorPluginManager $transactor_manager) {
    $this->entityTypeManager = $entity_type_manager;
    $this->transactorManager = $transactor_manager;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'transaction_type_creation';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $entity_types = [];
    foreach ($this->entityTypeManager
      ->getDefinitions() as $entity_type_id => $entity_type) {
      if ($entity_type instanceof ContentEntityTypeInterface) {
        $entity_types[$entity_type_id] = $entity_type
          ->getLabel();
      }
    }
    asort($entity_types);
    $form['target_entity_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Target entity type'),
      '#description' => $this
        ->t('The target entity type. This cannot be changed once the transaction type is created.'),
      '#options' => $entity_types,
      '#default_value' => 'node',
      '#required' => TRUE,
    ];
    $form['transactor'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Transactor'),
      '#description' => $this
        ->t('Select the plugin type that operates the transaction. This cannot be changed once the transaction type is created.'),
      '#options' => [],
      '#required' => TRUE,
    ];
    foreach ($this->transactorManager
      ->getTransactors() as $id => $info) {
      $form['transactor']['#options'][$id] = $info['title'];
      $form['transactor'][$id]['#description'] = $info['description'];
    }
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Continue'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $form_state
      ->setRedirect('entity.transaction_type.add_form', [
      'target_entity_type' => $form_state
        ->getValue('target_entity_type'),
      'transactor' => $form_state
        ->getValue('transactor'),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    if (($transactor_id = $form_state
      ->getValue('transactor')) && ($transactor_info = $this->transactorManager
      ->getTransactor($transactor_id))) {

      // Check for supported entity types.
      if (!empty($transactor_info['supported_entity_types']) && !in_array($target_entity_type_id = $form_state
        ->getValue('target_entity_type'), $transactor_info['supported_entity_types'])) {
        $form_state
          ->setErrorByName('target_entity_type', $this
          ->t('The %type entity type is not supported by the @transactor transactor.', [
          '%type' => $target_entity_type_id ? $this->entityTypeManager
            ->getDefinition($target_entity_type_id)
            ->getLabel() : $this
            ->t('Undefined'),
          '@transactor' => $transactor_info['title'],
        ]));
      }
    }
    else {

      // Empty or invalid transactor.
      $form_state
        ->setErrorByName('transactor', $this
        ->t('Invalid transactor.'));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
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.
TransactionTypeCreationForm::$entityTypeManager protected property The entity type manager.
TransactionTypeCreationForm::$transactorManager protected property The transactor plugin manager.
TransactionTypeCreationForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
TransactionTypeCreationForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
TransactionTypeCreationForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
TransactionTypeCreationForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
TransactionTypeCreationForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
TransactionTypeCreationForm::__construct public function Constructs a new transaction type creation form.
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.