class StateTransitionForm in State Machine 8

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\state_machine\Form\StateTransitionForm implements StateTransitionFormInterface

Expanded class hierarchy of StateTransitionForm

1 file declares its use of StateTransitionForm

StateTransitionFormFormatter.php in src/Plugin/Field/FieldFormatter/StateTransitionFormFormatter.php

File

src/Form/StateTransitionForm.php, line 10

Namespace

Drupal\state_machine\Form

View source

class StateTransitionForm extends FormBase implements StateTransitionFormInterface {

  /**
   * The entity.
   *
   * @var \Drupal\Core\Entity\ContentEntityInterface
   */
  protected $entity;

  /**
   * The state field name.
   *
   * @var string
   */
  protected $fieldName;

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

  /**
   * {@inheritdoc}
   */
  public function setEntity(ContentEntityInterface $entity) {
    $this->entity = $entity;
    return $this;
  }

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

  /**
   * {@inheritdoc}
   */
  public function setFieldName($field_name) {
    $this->fieldName = $field_name;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getBaseFormId() {
    return 'state_machine_transition_form';
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    $entity = $this
      ->getEntity();
    if (!$entity) {
      throw new \RuntimeException('No entity provided to StateTransitionForm.');
    }

    // Example ID: "state_machine_transition_form_commerce_order_state_1".
    $form_id = $this
      ->getBaseFormId();
    $form_id .= '_' . $entity
      ->getEntityTypeId() . '_' . $this->fieldName;
    $form_id .= '_' . $entity
      ->id();
    return $form_id;
  }

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

    /** @var \Drupal\state_machine\Plugin\Field\FieldType\StateItemInterface $state_item */
    $state_item = $this->entity
      ->get($this->fieldName)
      ->first();
    $form['actions'] = [
      '#type' => 'container',
    ];

    // Determine whether we should output links to the confirmation form,
    // or submit buttons.
    $require_confirmation = $form_state
      ->get('require_confirmation');
    foreach ($state_item
      ->getTransitions() as $transition_id => $transition) {
      if (!$require_confirmation) {
        $form['actions'][$transition_id] = [
          '#type' => 'submit',
          '#value' => $transition
            ->getLabel(),
          '#submit' => [
            '::submitForm',
          ],
          '#transition' => $transition,
        ];
        continue;
      }
      $url = $this->entity
        ->toUrl('state-transition-form');
      $route_parameters = $url
        ->getRouteParameters() + [
        $this->entity
          ->getEntityTypeId() => $this->entity
          ->id(),
        'field_name' => $this->fieldName,
        'transition_id' => $transition_id,
      ];
      $form['actions'][$transition_id] = [
        '#type' => 'link',
        '#title' => $transition
          ->getLabel(),
        '#url' => Url::fromRoute("entity.{$this->entity->getEntityTypeId()}.state_transition_form", $route_parameters),
        '#attributes' => [
          'class' => [
            'button',
          ],
        ],
      ];
      if ($form_state
        ->get('use_modal')) {
        $form['actions'][$transition_id]['#attributes']['class'][] = 'use-ajax';
        $form['actions'][$transition_id]['#attributes']['data-dialog-type'] = 'modal';
        $form['#attached']['library'][] = 'core/drupal.dialog.ajax';
      }
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $triggering_element = $form_state
      ->getTriggeringElement();

    /** @var \Drupal\state_machine\Plugin\Workflow\WorkflowTransition $transition */
    $transition = $triggering_element['#transition'];

    /** @var \Drupal\state_machine\Plugin\Field\FieldType\StateItemInterface $state_item */
    $state_item = $this->entity
      ->get($this->fieldName)
      ->first();

    // Ensure the transition is still allowed before applying it.
    if ($state_item
      ->isTransitionAllowed($transition
      ->getId())) {
      $state_item
        ->applyTransition($triggering_element['#transition']);
      $this->entity
        ->save();
    }
  }

}

Members

Name	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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	87
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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
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.
StateTransitionForm::$entity	protected	property	The entity.
StateTransitionForm::$fieldName	protected	property	The state field name.
StateTransitionForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
StateTransitionForm::getBaseFormId	public	function	Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId
StateTransitionForm::getEntity	public	function	Gets the form entity. Overrides StateTransitionFormInterface::getEntity
StateTransitionForm::getFieldName	public	function	Gets the state field name. Overrides StateTransitionFormInterface::getFieldName
StateTransitionForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
StateTransitionForm::setEntity	public	function	Sets the form entity. Overrides StateTransitionFormInterface::setEntity
StateTransitionForm::setFieldName	public	function	Sets the state field name. Overrides StateTransitionFormInterface::setFieldName
StateTransitionForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
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.
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.

You are here

class StateTransitionForm in State Machine 8

Hierarchy

File

Namespace

Members

API Navigation