class WorkflowConfigTransitionLabelForm in Workflow 8

Defines a class to build a draggable listing of Workflow Config Transitions entities.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
    • class \Drupal\workflow\Form\WorkflowConfigTransitionFormBase
      • class \Drupal\workflow\Form\WorkflowConfigTransitionLabelForm

See also

\Drupal\workflow\Entity\WorkflowConfigTransition

1 string reference to 'WorkflowConfigTransitionLabelForm'

workflow.routing.yml in ./workflow.routing.yml

workflow.routing.yml

File

src/Form/WorkflowConfigTransitionLabelForm.php, line 13

Namespace

Drupal\workflow\Form

class WorkflowConfigTransitionLabelForm extends WorkflowConfigTransitionFormBase {

  /**
   * {@inheritdoc}
   */
  protected $entitiesKey = 'workflow_config_transition';

  /**
   * {@inheritdoc}
   */
  protected $type = 'label';

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header = [
      'from' => $this
        ->t('Transition from'),
      'to' => $this
        ->t('Transition to'),
      'label_new' => $this
        ->t('label'),
      'config_transition' => '',
    ];
    return $header;
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $row = [];
    $workflow = $this->workflow;
    if ($workflow) {

      /** @var \Drupal\workflow\Entity\WorkflowConfigTransition $entity */
      $config_transition = $entity;
      static $previous_from_sid = -1;

      // Get transitions, sorted by weight of the old state.
      $from_state = $config_transition
        ->getFromState();
      $to_state = $config_transition
        ->getToState();
      $from_sid = $from_state
        ->id();

      // Skip the transitions without any roles.
      $skip = TRUE;
      foreach ($config_transition->roles as $rid => $active) {
        if ($active) {
          $skip = FALSE;
        }
      }
      if ($skip == TRUE && $from_state != $to_state) {
        return $row;
      }
      $row['from'] = [
        '#type' => 'value',
        '#markup' => $previous_from_sid != $from_sid ? $from_state
          ->label() : '"',
      ];
      $row['to'] = [
        '#type' => 'value',
        '#markup' => $to_state
          ->label(),
      ];
      $row['label_new'] = [
        '#type' => 'textfield',
        '#default_value' => $config_transition
          ->get('label'),
      ];
      $row['config_transition'] = [
        '#type' => 'value',
        '#value' => $config_transition,
      ];
      $previous_from_sid = $from_sid;
    }
    return $row;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    foreach ($form_state
      ->getValue($this->entitiesKey) as $value) {
      $new_label = trim($value['label_new']);
      $value['config_transition']
        ->set('label', $new_label)
        ->save();
    }
    $this
      ->messenger()
      ->addStatus($this
      ->t('The transition labels have been saved.'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
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::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.
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.
WorkflowConfigTransitionFormBase::$entities	protected	property	The entities being listed.
WorkflowConfigTransitionFormBase::$logger	protected	property	The messenger / logger service.
WorkflowConfigTransitionFormBase::$workflow	protected	property	The workflow object.
WorkflowConfigTransitionFormBase::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
WorkflowConfigTransitionFormBase::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
WorkflowConfigTransitionFormBase::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames	1
WorkflowConfigTransitionFormBase::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId	1
WorkflowConfigTransitionFormBase::load	public	function	Create an $entity for every ConfigTransition.
WorkflowConfigTransitionFormBase::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
WorkflowConfigTransitionLabelForm::$entitiesKey	protected	property	The key to use for the form element containing the entities. Overrides WorkflowConfigTransitionFormBase::$entitiesKey
WorkflowConfigTransitionLabelForm::$type	protected	property	The WorkflowConfigTransition form type. Overrides WorkflowConfigTransitionFormBase::$type
WorkflowConfigTransitionLabelForm::buildHeader	public	function
WorkflowConfigTransitionLabelForm::buildRow	public	function
WorkflowConfigTransitionLabelForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm