public function FormAlterHelper::alterForm in Workbench Access 8

Alters the given form.

Parameters

array $element: Element to alter. May be the whole form, or a sub-form.

array $complete_form: Complete form.

\Drupal\Core\Form\FormStateInterface $form_state: Active form state data.

\Drupal\Core\Entity\ContentEntityInterface $entity: The entity object that the form is modifying.

Return value

array The altered element.

File

src/FormAlterHelper.php, line 69

Class

FormAlterHelper

Defines a helper for altering content edit forms.

Namespace

Drupal\workbench_access

Code

public function alterForm(array &$element, array &$complete_form, FormStateInterface &$form_state, ContentEntityInterface $entity) {
  $callback = FALSE;
  if (empty($entity)) {
    $entity = $form_state
      ->getFormObject()
      ->getEntity();
  }

  /** @var \Drupal\workbench_access\Entity\AccessSchemeInterface $access_scheme */
  foreach ($this->entityTypeManager
    ->getStorage('access_scheme')
    ->loadMultiple() as $access_scheme) {

    // If no access field is set, we do nothing.
    $scheme = $access_scheme
      ->getAccessScheme();
    if (!$scheme
      ->applies($entity
      ->getEntityTypeId(), $entity
      ->bundle())) {
      continue;
    }
    $callback = TRUE;

    // Load field data that can be edited.
    // If the user cannot access the form element or is a superuser, ignore.
    if (!$this->currentUser
      ->hasPermission('bypass workbench access')) {

      // In the case of entity_autocomplete, the Taxonomy scheme will update
      // the form for us. Be careful not to overwrite its values.
      $scheme
        ->alterForm($access_scheme, $element, $form_state, $entity);
      if (!isset($complete_form['workbench_access_disallowed'])) {
        $complete_form['workbench_access_disallowed'] = [
          '#tree' => TRUE,
        ];
      }

      // Add the options hidden from the user silently to the form.
      $fields = $scheme
        ->getApplicableFields($entity
        ->getEntityTypeId(), $entity
        ->bundle());
      foreach ($fields as $info) {
        if (isset($complete_form[$info['field']])) {
          $lookup_element = $complete_form[$info['field']];
          $options_diff = $scheme
            ->disallowedOptions($lookup_element);
          if (!empty($options_diff) && !isset($complete_form['workbench_access_disallowed'][$info['field']])) {

            // @TODO: Potentially show this information to users with permission.
            $complete_form['workbench_access_disallowed'][$info['field']] = [
              $access_scheme
                ->id() => [
                '#type' => 'value',
                '#value' => $options_diff,
              ],
            ];
          }
        }
      }
    }
  }
  if ($callback) {

    // Call our submitEntity() method to merge in values.
    // @todo Add tests for this.
    $class = AccessControlHierarchyBase::class . '::submitEntity';

    // Account for all the submit buttons on the form.
    $buttons = [
      'submit',
      'publish',
      'unpublish',
    ];
    foreach ($buttons as $button) {
      if (isset($complete_form['actions'][$button]['#submit'])) {
        array_unshift($complete_form['actions'][$button]['#submit'], $class);
      }
    }
  }
  return $element;
}