class WorkflowStateDeleteForm

Same name in other branches
  1. 8.9.x core/modules/workflows/src/Form/WorkflowStateDeleteForm.php \Drupal\workflows\Form\WorkflowStateDeleteForm
  2. 10 core/modules/workflows/src/Form/WorkflowStateDeleteForm.php \Drupal\workflows\Form\WorkflowStateDeleteForm
  3. 11.x core/modules/workflows/src/Form/WorkflowStateDeleteForm.php \Drupal\workflows\Form\WorkflowStateDeleteForm

Builds the form to delete states from Workflow entities.

@internal

Hierarchy

Expanded class hierarchy of WorkflowStateDeleteForm

1 string reference to 'WorkflowStateDeleteForm'
workflows.routing.yml in core/modules/workflows/workflows.routing.yml
core/modules/workflows/workflows.routing.yml

File

core/modules/workflows/src/Form/WorkflowStateDeleteForm.php, line 15

Namespace

Drupal\workflows\Form
View source
class WorkflowStateDeleteForm extends ConfirmFormBase {
    
    /**
     * The workflow entity the state being deleted belongs to.
     *
     * @var \Drupal\workflows\WorkflowInterface
     */
    protected $workflow;
    
    /**
     * The state being deleted.
     *
     * @var string
     */
    protected $stateId;
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'workflow_state_delete_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function getQuestion() {
        return $this->t('Are you sure you want to delete %state from %workflow?', [
            '%state' => $this->workflow
                ->getTypePlugin()
                ->getState($this->stateId)
                ->label(),
            '%workflow' => $this->workflow
                ->label(),
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCancelUrl() {
        return $this->workflow
            ->toUrl();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfirmText() {
        return $this->t('Delete');
    }
    
    /**
     * Form constructor.
     *
     * @param array $form
     *   An associative array containing the structure of the form.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     * @param \Drupal\workflows\WorkflowInterface $workflow
     *   The workflow entity being edited.
     * @param string|null $workflow_state
     *   The workflow state being deleted.
     *
     * @return array
     *   The form structure.
     */
    public function buildForm(array $form, FormStateInterface $form_state, WorkflowInterface $workflow = NULL, $workflow_state = NULL) {
        if (!$workflow->getTypePlugin()
            ->hasState($workflow_state)) {
            throw new NotFoundHttpException();
        }
        $this->workflow = $workflow;
        $this->stateId = $workflow_state;
        if ($this->workflow
            ->getTypePlugin()
            ->workflowStateHasData($this->workflow, $this->workflow
            ->getTypePlugin()
            ->getState($this->stateId))) {
            $form['#title'] = $this->getQuestion();
            $form['description'] = [
                '#markup' => $this->t('This workflow state is in use. You cannot remove this workflow state until you have removed all content using it.'),
            ];
            return $form;
        }
        return parent::buildForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $workflow_label = $this->workflow
            ->getTypePlugin()
            ->getState($this->stateId)
            ->label();
        $this->workflow
            ->getTypePlugin()
            ->deleteState($this->stateId);
        $this->workflow
            ->save();
        $this->messenger()
            ->addStatus($this->t('State %label deleted.', [
            '%label' => $workflow_label,
        ]));
        $form_state->setRedirectUrl($this->getCancelUrl());
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText 2
ConfirmFormBase::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription 15
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
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. 3
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 105
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.
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 73
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. 17
MessengerTrait::messenger public function Gets the messenger. 17
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. 3
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.
WorkflowStateDeleteForm::$stateId protected property The state being deleted.
WorkflowStateDeleteForm::$workflow protected property The workflow entity the state being deleted belongs to.
WorkflowStateDeleteForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
WorkflowStateDeleteForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
WorkflowStateDeleteForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
WorkflowStateDeleteForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
WorkflowStateDeleteForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
WorkflowStateDeleteForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.