function FormOperations::formAlter

Same name in other branches
  1. 9 core/modules/workspaces/src/FormOperations.php \Drupal\workspaces\FormOperations::formAlter()
  2. 8.9.x core/modules/workspaces/src/FormOperations.php \Drupal\workspaces\FormOperations::formAlter()
  3. 11.x core/modules/workspaces/src/FormOperations.php \Drupal\workspaces\FormOperations::formAlter()

Alters forms to disallow editing in non-default workspaces.

Parameters

array $form: An associative array containing the structure of the form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

string $form_id: The form ID.

See also

hook_form_alter()

File

core/modules/workspaces/src/FormOperations.php, line 58

Class

FormOperations
Defines a class for reacting to form operations.

Namespace

Drupal\workspaces

Code

public function formAlter(array &$form, FormStateInterface $form_state, $form_id) {
    // No alterations are needed if we're not in a workspace context.
    if (!$this->workspaceManager
        ->hasActiveWorkspace()) {
        return;
    }
    // Add a validation step for every form if we are in a workspace.
    $this->addWorkspaceValidation($form);
    // If a form has already been marked as safe or not to submit in a
    // workspace, we don't have anything else to do.
    if ($form_state->has('workspace_safe')) {
        return;
    }
    $form_object = $form_state->getFormObject();
    $workspace_safe = $form_object instanceof WorkspaceSafeFormInterface || $form_object instanceof WorkspaceDynamicSafeFormInterface && $form_object->isWorkspaceSafeForm($form, $form_state);
    $form_state->set('workspace_safe', $workspace_safe);
}

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