public function ContentLockSettingsForm::buildForm in Content locking (anti-concurrent editing) 8.2

Same name and namespace in other branches

1. 8 src/Form/ContentLockSettingsForm.php \Drupal\content_lock\Form\ContentLockSettingsForm::buildForm()

Form constructor.

Parameters

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

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

Return value

array The form structure.

Overrides ConfigFormBase::buildForm

File

src/Form/ContentLockSettingsForm.php, line 76

Class

ContentLockSettingsForm

Class ContentLockSettingsForm.

Namespace

Drupal\content_lock\Form

Code

public function buildForm(array $form, FormStateInterface $form_state) {
  $config = $this
    ->config('content_lock.settings');
  $form['general'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Verbose'),
    '#open' => TRUE,
    '#tree' => TRUE,
    '#process' => [
      [
        get_class($this),
        'formProcessMergeParent',
      ],
    ],
    '#weight' => 0,
  ];
  $form['general']['verbose'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Enable this option to display a message to the user when they lock a content item by editing it.'),
    '#description' => $this
      ->t('Users trying to edit a content locked still see the content lock message.'),
    '#default_value' => $config
      ->get('verbose'),
    '#return_value' => 1,
    '#empty' => 0,
  ];
  $form['entities'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Entity type protected'),
    '#open' => TRUE,
    '#tree' => TRUE,
    '#process' => [
      [
        get_class($this),
        'formProcessMergeParent',
      ],
    ],
    '#weight' => 1,
  ];
  $definitions = $this->entityTypeManager
    ->getDefinitions();
  $entity_types = [];
  $selected_entity_types = [];
  foreach ($definitions as $definition) {
    if ($definition instanceof ContentEntityTypeInterface) {
      $entity_types[$definition
        ->id()] = $definition
        ->getLabel();
      if (!empty($config
        ->get('types.' . $definition
        ->id()))) {
        $selected_entity_types[] = $definition
          ->id();
      }
    }
  }
  $form['entities']['entity_types'] = [
    '#type' => 'checkboxes',
    '#title' => 'Protected entity types',
    '#options' => $entity_types,
    '#default_value' => $selected_entity_types,
    '#attributes' => [
      'class' => [
        'content-lock-entity-types',
      ],
    ],
  ];
  foreach ($definitions as $definition) {
    if ($definition instanceof ContentEntityTypeInterface) {
      $form['entities'][$definition
        ->id()] = [
        '#type' => 'container',
        '#title' => $definition
          ->getLabel(),
        '#theme' => 'content_lock_settings_entities',
        '#states' => [
          'visible' => [
            ':input[name="entity_types[' . $definition
              ->id() . ']"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
        '#attributes' => [
          'class' => [
            $definition
              ->id(),
          ],
        ],
      ];
      $options = [
        '*' => $this
          ->t('All'),
      ];
      if ($definition
        ->getBundleEntityType()) {
        $bundles = $this->entityTypeManager
          ->getStorage($definition
          ->getBundleEntityType())
          ->loadMultiple();
        foreach ($bundles as $bundle) {
          $options[$bundle
            ->id()] = $bundle
            ->label();
        }
      }
      else {
        $options[$definition
          ->id()] = $definition
          ->getLabel();
      }
      $form['entities'][$definition
        ->id()]['bundles'] = [
        '#type' => 'checkboxes',
        '#title' => $definition
          ->getBundleLabel() ?: $definition
          ->getLabel(),
        '#description' => $this
          ->t('Select the bundles on which enable content lock'),
        '#options' => $options,
        '#default_value' => $config
          ->get('types.' . $definition
          ->id()) ?: [],
        '#attributes' => [
          'class' => [
            'content-lock-entity-settings',
          ],
        ],
      ];
      $form['entities'][$definition
        ->id()]['settings']['translation_lock'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Lock only on entity translation level.'),
        '#default_value' => in_array($definition
          ->id(), $config
          ->get('types_translation_lock') ?: []),
        '#description' => $this
          ->t('Activating this options allows users to edit multiple translations concurrently'),
      ];
      if (!$this->moduleHandler
        ->moduleExists('conflict')) {
        $form['entities'][$definition
          ->id()]['settings']['translation_lock'] = [
          '#disabled' => TRUE,
          '#default_value' => FALSE,
          '#description' => $this
            ->t('To allow editing multiple translations concurrently you need to install %module', [
            '%module' => Link::fromTextAndUrl('Conflict', Url::fromUri('https://www.drupal.org/project/conflict'))
              ->toString(),
          ]),
        ] + $form['entities'][$definition
          ->id()]['settings']['translation_lock'];
      }
      $form['entities'][$definition
        ->id()]['settings']['js_lock'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Lock form using JS.'),
        '#default_value' => in_array($definition
          ->id(), $config
          ->get('types_js_lock') ?: []),
        '#description' => $this
          ->t('Activating this options activates the lock when the user is on the form. This helps if modules interacting with form without a user interacting with the form, like the prefetch_cache module.'),
      ];
      if (!empty($definition
        ->getHandlerClasses()['form'])) {
        $form['entities'][$definition
          ->id()]['settings']['form_op_lock'] = [
          '#tree' => 1,
        ];
        $form['entities'][$definition
          ->id()]['settings']['form_op_lock']['mode'] = [
          '#type' => 'radios',
          '#title' => $this
            ->t('Lock only on entity form operation level.'),
          '#options' => [
            ContentLock::FORM_OP_MODE_DISABLED => $this
              ->t('Disabled'),
            ContentLock::FORM_OP_MODE_WHITELIST => $this
              ->t('Enable lock for selected form operations'),
            ContentLock::FORM_OP_MODE_BLACKLIST => $this
              ->t('Disable lock for selected form operations'),
          ],
          '#default_value' => $config
            ->get('form_op_lock.' . $definition
            ->id() . '.mode') ?: ContentLock::FORM_OP_MODE_DISABLED,
          '#description' => $this
            ->t('Activating this options allows users to edit different entity forms concurrently'),
        ];
        $form_ops = array_keys($definition
          ->getHandlerClasses()['form']);
        $form_ops = array_combine($form_ops, $form_ops);
        $form['entities'][$definition
          ->id()]['settings']['form_op_lock']['values'] = [
          '#type' => 'checkboxes',
          '#title' => $this
            ->t('Form operations'),
          '#options' => $form_ops,
          '#default_value' => (array) $config
            ->get('form_op_lock.' . $definition
            ->id() . '.values'),
          '#states' => [
            'invisible' => [
              ':input[name="' . $definition
                ->id() . '[settings][form_op_lock][mode]"]' => [
                'value' => ContentLock::FORM_OP_MODE_DISABLED,
              ],
            ],
          ],
        ];
      }
    }
  }
  $form['#attached']['library'][] = 'content_lock/drupal.content_lock.settings';
  return parent::buildForm($form, $form_state);
}