class WorkflowCleanupSettingsForm in Workflow 8

Provides a Form for organizing obsolete States.

@package Drupal\workflow_cleanup\Form

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\workflow_cleanup\Form\WorkflowCleanupSettingsForm

Expanded class hierarchy of WorkflowCleanupSettingsForm

1 string reference to 'WorkflowCleanupSettingsForm'

workflow_cleanup.routing.yml in modules/workflow_cleanup/workflow_cleanup.routing.yml: modules/workflow_cleanup/workflow_cleanup.routing.yml

File

modules/workflow_cleanup/src/Form/WorkflowCleanupSettingsForm.php, line 15

Namespace

Drupal\workflow_cleanup\Form

View source

class WorkflowCleanupSettingsForm extends FormBase {

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

  /**
   * @inheritdoc
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = [];

    // Get all of the states, indexed by sid.
    $orphans = $inactive = [];

    /** @var \Drupal\workflow\Entity\WorkflowState[] $states */

    /** @var \Drupal\workflow\Entity\WorkflowState $state */
    $states = WorkflowState::loadMultiple();
    foreach ($states as $state) {

      // Does the associated workflow exist?
      if (!$state
        ->getWorkflow()) {
        $orphans[$state
          ->id()] = $state;
      }
      else {

        // Is the state still active?
        if (!$state
          ->isActive()) {
          $inactive[$state
            ->id()] = $state;
        }
      }
    }

    // Save the relevant states in an indexed array.
    $form['#workflow_states'] = $orphans + $inactive;
    $form['no_workflow'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Orphaned States'),
      '#open' => TRUE,
      // Controls the HTML5 'open' attribute. Defaults to FALSE.
      '#description' => $this
        ->t('These states no longer belong to an existing workflow.'),
      '#tree' => TRUE,
    ];
    foreach ($orphans as $sid => $state) {
      $form['no_workflow'][$sid]['check'] = [
        '#type' => 'checkbox',
        '#title' => $state
          ->label(),
        '#return_value' => $sid,
      ];
    }
    $form['inactive'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Inactive (Deleted) States'),
      '#open' => TRUE,
      // Controls the HTML5 'open' attribute. Defaults to FALSE.
      '#description' => $this
        ->t('These states belong to a workflow, but have been marked inactive (deleted).'),
      '#tree' => TRUE,
    ];
    foreach ($inactive as $sid => $state) {
      $form['inactive'][$sid]['check'] = [
        '#type' => 'checkbox',
        '#title' => $state
          ->label() . ' (' . $state
          ->getWorkflow()
          ->label() . ')',
        '#return_value' => $sid,
      ];
    }
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Delete selected states'),
    ];
    return $form;
  }

  /**
   * @inheritdoc
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $states = $form['#workflow_states'];
    $values = $form_state
      ->getValues();
    foreach ([
      'no_workflow',
      'inactive',
    ] as $section) {
      if (!isset($values[$section])) {
        continue;
      }
      foreach ($values[$section] as $sid => $data) {
        if (!$data['check']) {
          continue;
        }

        /** @var \Drupal\workflow\Entity\WorkflowState $state */
        $state = $states[$sid];
        $state_name = $state
          ->label();

        // Delete any transitions this state is involved in.
        $count = 0;
        foreach (WorkflowConfigTransition::loadMultiple() as $config_transition) {

          /** @var \Drupal\workflow\Entity\WorkflowConfigTransition $config_transition */
          if ($config_transition
            ->getFromSid() == $sid || $config_transition
            ->getToSid() == $sid) {
            $config_transition
              ->delete();
            $count++;
          }
        }
        if ($count) {
          $this
            ->messenger()
            ->addStatus($this
            ->t('@count transitions for the "@state" state have been deleted.', [
            '@state' => $state_name,
            '@count' => $count,
          ]));
        }

        // @todo Remove history records, too.
        $count = 0;

        // $count = db_delete('workflow_node_history')->condition('sid', $sid)->execute();
        if ($count) {
          $this
            ->messenger()
            ->addStatus($this
            ->t('@count history records for the "@state" state have been deleted.', [
            '@state' => $state_name,
            '@count' => $count,
          ]));
        }
        $state
          ->delete();
        $this
          ->messenger()
          ->addStatus($this
          ->t('The "@state" state has been deleted.', [
          '@state' => $state_name,
        ]));
      }
    }
  }

}

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.
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.
WorkflowCleanupSettingsForm::buildForm	public	function	@inheritdoc Overrides FormInterface::buildForm
WorkflowCleanupSettingsForm::getFormId	public	function	@inheritdoc Overrides FormInterface::getFormId
WorkflowCleanupSettingsForm::submitForm	public	function	@inheritdoc Overrides FormInterface::submitForm

You are here

class WorkflowCleanupSettingsForm in Workflow 8

Hierarchy

File

Namespace

Members

API Navigation