You are here

Home » API reference » Drupal 10 » WorkspaceActivateForm.php

class WorkspaceActivateForm in Drupal 10

Same name and namespace in other branches
  1. 8 core/modules/workspaces/src/Form/WorkspaceActivateForm.php \Drupal\workspaces\Form\WorkspaceActivateForm
  2. 9 core/modules/workspaces/src/Form/WorkspaceActivateForm.php \Drupal\workspaces\Form\WorkspaceActivateForm

Handle activation of a workspace on administrative pages.

Hierarchy

Expanded class hierarchy of WorkspaceActivateForm

File

core/modules/workspaces/src/Form/WorkspaceActivateForm.php, line 17

Namespace

Drupal\workspaces\Form
View source 
class WorkspaceActivateForm extends EntityConfirmFormBase implements WorkspaceFormInterface {

  /**
   * The workspace entity.
   *
   * @var \Drupal\workspaces\WorkspaceInterface
   */
  protected $entity;

  /**
   * The workspace replication manager.
   *
   * @var \Drupal\workspaces\WorkspaceManagerInterface
   */
  protected $workspaceManager;

  /**
   * The messenger service.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * Constructs a new WorkspaceActivateForm.
   *
   * @param \Drupal\workspaces\WorkspaceManagerInterface $workspace_manager
   *   The workspace manager.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger service.
   */
  public function __construct(WorkspaceManagerInterface $workspace_manager, MessengerInterface $messenger) {
    $this->workspaceManager = $workspace_manager;
    $this->messenger = $messenger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('workspaces.manager'), $container
      ->get('messenger'));
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->t('Would you like to activate the %workspace workspace?', [
      '%workspace' => $this->entity
        ->label(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this
      ->t('Activate the %workspace workspace.', [
      '%workspace' => $this->entity
        ->label(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return $this->entity
      ->toUrl('collection');
  }

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

    // Content entity forms do not use the parent's #after_build callback.
    unset($form['#after_build']);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function actions(array $form, FormStateInterface $form_state) {
    $actions = parent::actions($form, $form_state);
    $actions['cancel']['#attributes']['class'][] = 'dialog-cancel';
    return $actions;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    try {
      $this->workspaceManager
        ->setActiveWorkspace($this->entity);
      $this->messenger
        ->addMessage($this
        ->t('%workspace_label is now the active workspace.', [
        '%workspace_label' => $this->entity
          ->label(),
      ]));
    } catch (WorkspaceAccessException $e) {
      $this->messenger
        ->addError($this
        ->t('You do not have access to activate the %workspace_label workspace.', [
        '%workspace_label' => $this->entity
          ->label(),
      ]));
    }

    // Redirect to the workspace manage page by default.
    if (!$this
      ->getRequest()->query
      ->has('destination')) {
      $form_state
        ->setRedirectUrl($this->entity
        ->toUrl());
    }
  }

  /**
   * Checks access for the workspace activate form.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match.
   *
   * @return \Drupal\Core\Access\AccessResult
   *   The access result.
   */
  public function checkAccess(RouteMatchInterface $route_match) {

    /** @var \Drupal\workspaces\WorkspaceInterface $workspace */
    $workspace = $route_match
      ->getParameter('workspace');
    $active_workspace = $this->workspaceManager
      ->getActiveWorkspace();
    $access = AccessResult::allowedIf(!$active_workspace || $active_workspace && $active_workspace
      ->id() != $workspace
      ->id())
      ->addCacheableDependency($workspace);
    return $access;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityConfirmFormBase::delete public function The delete() method is not used in EntityConfirmFormBase. This overrides the default implementation that redirects to the delete-form confirmation form.
EntityConfirmFormBase::getBaseFormId public function
EntityConfirmFormBase::getCancelText public function
EntityConfirmFormBase::getConfirmText public function 1
EntityConfirmFormBase::getFormName public function
EntityConfirmFormBase::save public function The save() method is not used in EntityConfirmFormBase. This overrides the default implementation that saves the entity.
EntityForm::$entityTypeManager protected property The entity type manager. 2
EntityForm::$moduleHandler protected property The module handler service.
EntityForm::$operation protected property The name of the current operation.
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity 3
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties. 9
EntityForm::form public function Gets the actual form array to be built. 27
EntityForm::getEntity public function Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch 3
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 11
EntityForm::getOperation public function Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::init protected function Initialize the form state and the entity before the first form build. 3
EntityForm::prepareEntity protected function Prepares the entity object before the form is built first. 3
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityTypeManager public function Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Sets the operation for this form. Overrides EntityFormInterface::setOperation
FormBase::$configFactory protected property The config factory. 3
FormBase::$requestStack protected property The request stack.
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::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 49
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 public function Gets the messenger. 13
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.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
WorkspaceActivateForm::$entity protected property The workspace entity. Overrides EntityForm::$entity
WorkspaceActivateForm::$messenger protected property The messenger service. Overrides MessengerTrait::$messenger
WorkspaceActivateForm::$workspaceManager protected property The workspace replication manager.
WorkspaceActivateForm::actions public function Returns an array of supported actions for the current entity form. Overrides EntityConfirmFormBase::actions
WorkspaceActivateForm::buildForm public function Form constructor. Overrides EntityConfirmFormBase::buildForm
WorkspaceActivateForm::checkAccess public function Checks access for the workspace activate form.
WorkspaceActivateForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
WorkspaceActivateForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
WorkspaceActivateForm::getDescription public function Returns additional text to display as a description. Overrides EntityConfirmFormBase::getDescription
WorkspaceActivateForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
WorkspaceActivateForm::submitForm public function This is the default entity object builder function. It is called before any other submit handler to build the new entity object to be used by the following submit handlers. At this point of the form workflow the entity is validated and the form state… Overrides EntityForm::submitForm
WorkspaceActivateForm::__construct public function Constructs a new WorkspaceActivateForm.