class WorkspaceSwitcherForm in Workspace 8

Switcher for to activate a different workspace.

This is a separate form for each workspace rather than one big form with many buttons for scaling reasons. For example, this form may show up in a toolbar. We may want to show just a subset of workspaces to switch to, maybe access control, etc. This approach keeps that logic out of the switching process itself.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\workspace\Form\WorkspaceActivateFormBase
    • class \Drupal\workspace\Form\WorkspaceSwitcherForm

1 file declares its use of WorkspaceSwitcherForm

Toolbar.php in src/Toolbar.php

File

src/Form/WorkspaceSwitcherForm.php, line 17

Namespace

Drupal\workspace\Form

class WorkspaceSwitcherForm extends WorkspaceActivateFormBase {

  /**
   * Hack to allow us to show this form multiple times on a page.
   *
   * @see https://www.drupal.org/node/766146
   *
   * @var int
   */
  protected static $formCounter = 1;

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'workspace_switcher_form_' . static::$formCounter++;
  }

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

    // @todo this form is identical to WorkspaceActivateForm except for this method; can we consolidate forms?
    $form['workspace_id'] = [
      '#type' => 'hidden',
      '#value' => $workspace
        ->id(),
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $workspace
        ->label(),
    ];
    $active_workspace = $this->workspaceManager
      ->getActiveWorkspace();
    if ($active_workspace
      ->id() === $workspace
      ->id()) {
      $form['submit']['#attributes']['class'] = [
        'is-active',
      ];
    }
    return $form;
  }

}

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::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.
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.
WorkspaceActivateFormBase::$entityTypeManager	protected	property
WorkspaceActivateFormBase::$workspaceManager	protected	property
WorkspaceActivateFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
WorkspaceActivateFormBase::submitForm	public	function	@inheritDoc Overrides FormInterface::submitForm
WorkspaceActivateFormBase::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
WorkspaceActivateFormBase::__construct	public	function
WorkspaceSwitcherForm::$formCounter	protected static	property	Hack to allow us to show this form multiple times on a page.
WorkspaceSwitcherForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
WorkspaceSwitcherForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId