ChecklistapiChecklistForm.php 6.19 KB
Newer Older
1 2 3 4
<?php

namespace Drupal\checklistapi\Form;

5
use Drupal\Component\Utility\Xss;
6
use Drupal\Core\Form\FormInterface;
7
use Drupal\Core\Form\FormStateInterface;
8
use Drupal\Core\Render\Element;
9
use Drupal\Core\Url;
10
use Drupal\user\Entity\User;
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26

/**
 * Provides a checklist form.
 */
class ChecklistapiChecklistForm implements FormInterface {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'checklistapi_checklist_form';
  }

  /**
   * {@inheritdoc}
   */
27
  public function buildForm(array $form, FormStateInterface $form_state, $checklist_id = NULL) {
28 29 30 31
    $form['#checklist'] = $checklist = checklistapi_checklist_load($checklist_id);
    $user_has_edit_access = $checklist->userHasAccess('edit');

    // Progress bar.
32
    $form['progress_bar'] = [
33
      '#theme' => 'checklistapi_progress_bar',
34
      '#message' => ($checklist->hasSavedProgress()) ? t('Last updated @date by @user', [
35
        '@date' => $checklist->getLastUpdatedDate(),
36
        '@user' => $checklist->getLastUpdatedUser(),
37
      ]) : '',
38 39 40
      '#number_complete' => $checklist->getNumberCompleted(),
      '#number_of_items' => $checklist->getNumberOfItems(),
      '#percent_complete' => (int) round($checklist->getPercentComplete()),
41 42 43 44 45
      '#attached' => [
        'library' => [
          'classy/progress',
        ],
      ],
46
    ];
47 48

    // Compact mode.
49
    if (checklistapi_compact_mode_is_on()) {
50
      $form['#attributes']['class'] = ['compact-mode'];
51
    }
52
    $form['compact_mode_link'] = [
53
      '#markup' => '<div class="compact-link"></div>',
54
    ];
55 56

    // General properties.
57 58 59 60
    $form['checklistapi'] = [
      '#attached' => [
        'library' => ['checklistapi/checklistapi'],
      ],
61 62
      '#tree' => TRUE,
      '#type' => 'vertical_tabs',
63
    ];
64 65 66 67 68 69

    // Loop through groups.
    $num_autochecked_items = 0;
    $groups = $checklist->items;
    foreach (Element::children($groups) as $group_key) {
      $group = &$groups[$group_key];
70
      $form[$group_key] = [
71
        '#title' => Xss::filter($group['#title']),
72 73
        '#type' => 'details',
        '#group' => 'checklistapi',
74
      ];
75
      if (!empty($group['#description'])) {
76
        $form[$group_key]['#description'] = Xss::filterAdmin($group['#description']);
77 78 79 80 81 82 83
      }

      // Loop through items.
      foreach (Element::children($group) as $item_key) {
        $item = &$group[$item_key];
        $saved_item = !empty($checklist->savedProgress[$item_key]) ? $checklist->savedProgress[$item_key] : 0;
        // Build title.
84
        $title = Xss::filter($item['#title']);
85 86
        if ($saved_item) {
          // Append completion details.
87 88 89 90
          $title .= t('<span class="completion-details"> - Completed @time by @user</a>', [
            '@time' => format_date($saved_item['#completed'], 'short'),
            '@user' => User::load($saved_item['#uid'])->getUsername(),
          ]);
91 92 93 94 95 96 97 98 99 100 101 102
        }
        // Set default value.
        $default_value = FALSE;
        if ($saved_item) {
          $default_value = TRUE;
        }
        elseif (!empty($item['#default_value'])) {
          if ($default_value = $item['#default_value']) {
            $num_autochecked_items++;
          }
        }
        // Get description.
103
        $description = (isset($item['#description'])) ? '<p>' . Xss::filterAdmin($item['#description']) . '</p>' : '';
104
        // Append links.
105
        $links = [];
106 107
        foreach (Element::children($item) as $link_key) {
          $link = &$item[$link_key];
108
          $links[] = \Drupal::l($link['#text'], $link['#url']);
109 110 111 112 113
        }
        if (count($links)) {
          $description .= '<div class="links">' . implode(' | ', $links) . '</div>';
        }
        // Compile the list item.
114 115
        $form[$group_key][$item_key] = [
          '#attributes' => ['class' => ['checklistapi-item']],
116
          '#default_value' => $default_value,
117
          '#description' => Xss::filterAdmin($description),
118
          '#disabled' => !($user_has_edit_access),
119
          '#title' => Xss::filterAdmin($title),
120 121
          '#type' => 'checkbox',
          '#group' => $group_key,
122 123
          '#parents' => ['checklistapi', $group_key, $item_key],
        ];
124 125 126 127
      }
    }

    // Actions.
128
    $form['actions'] = [
129 130 131
      '#access' => $user_has_edit_access,
      '#type' => 'actions',
      '#weight' => 100,
132
      'save' => [
133 134 135
        '#button_type' => 'primary',
        '#type' => 'submit',
        '#value' => t('Save'),
136 137
      ],
      'clear' => [
138 139
        '#access' => $checklist->hasSavedProgress(),
        '#button_type' => 'danger',
140 141
        '#attributes' => ['class' => ['clear-saved-progress']],
        '#submit' => [[$this, 'clear']],
142 143
        '#type' => 'submit',
        '#value' => t('Clear saved progress'),
144 145
      ],
    ];
146 147 148 149 150

    // Alert the user of autochecked items. Only set the message on GET requests
    // to prevent it from reappearing after saving the form. (Testing the
    // request method may not be the "correct" way to accomplish this.)
    if ($num_autochecked_items && $_SERVER['REQUEST_METHOD'] == 'GET') {
151
      $args = [
152 153
        '%checklist' => $checklist->title,
        '@num' => $num_autochecked_items,
154
      ];
155 156 157 158 159 160 161 162 163 164 165 166 167
      $message = \Drupal::translation()->formatPlural(
        $num_autochecked_items,
        t('%checklist found 1 unchecked item that was already completed and checked it for you. Save the form to record the change.', $args),
        t('%checklist found @num unchecked items that were already completed and checked them for you. Save the form to record the changes.', $args)
      );
      drupal_set_message($message, 'status');
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
168
  public function validateForm(array &$form, FormStateInterface $form_state) {}
169 170 171 172

  /**
   * {@inheritdoc}
   */
173 174 175
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state->getValue('checklistapi');
    $form['#checklist']->saveProgress($values);
176 177 178 179 180 181 182
  }

  /**
   * Form submission handler for the 'clear' action.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
183 184
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
185
   */
186 187
  public function clear(array &$form, FormStateInterface $form_state) {
    $form_state->setRedirect($form['#checklist']->getRouteName() . '.clear');
188 189 190
  }

}