public function EntityUsageSettingsForm::buildForm in Entity Usage 8.4

Same name and namespace in other branches

1. 8 src/Form/EntityUsageSettingsForm.php \Drupal\entity_usage\Form\EntityUsageSettingsForm::buildForm()
2. 8.2 src/Form/EntityUsageSettingsForm.php \Drupal\entity_usage\Form\EntityUsageSettingsForm::buildForm()
3. 8.3 src/Form/EntityUsageSettingsForm.php \Drupal\entity_usage\Form\EntityUsageSettingsForm::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/EntityUsageSettingsForm.php, line 80

Class

EntityUsageSettingsForm

Form to configure entity_usage settings.

Namespace

Drupal\entity_usage\Form

Code

public function buildForm(array $form, FormStateInterface $form_state) {
  $config = $this
    ->config('entity_usage.settings');
  $all_entity_types = $this->entityTypeManager
    ->getDefinitions();
  $content_entity_types = [];

  // Filter the entity types.

  /** @var \Drupal\Core\Entity\EntityTypeInterface[] $entity_type_options */
  $entity_type_options = [];
  $tabs_options = [];
  foreach ($all_entity_types as $entity_type) {
    if ($entity_type instanceof ContentEntityTypeInterface) {
      $content_entity_types[$entity_type
        ->id()] = $entity_type
        ->getLabel();
    }
    $entity_type_options[$entity_type
      ->id()] = $entity_type
      ->getLabel();
    if ($entity_type
      ->hasLinkTemplate('canonical') || $entity_type
      ->hasLinkTemplate('edit-form')) {
      $tabs_options[$entity_type
        ->id()] = $entity_type
        ->getLabel();
    }
  }

  // Files and users shouldn't be tracked by default.
  unset($content_entity_types['file']);
  unset($content_entity_types['user']);

  // Tabs configuration.
  $form['local_task_enabled_entity_types'] = [
    '#type' => 'details',
    '#open' => TRUE,
    '#title' => $this
      ->t('Enabled local tasks'),
    '#description' => $this
      ->t('Check in which entity types there should be a tab (local task) linking to the usage page.'),
    '#tree' => TRUE,
  ];
  $form['local_task_enabled_entity_types']['entity_types'] = [
    '#type' => 'checkboxes',
    '#title' => $this
      ->t('Local task entity types'),
    '#options' => $tabs_options,
    '#default_value' => $config
      ->get('local_task_enabled_entity_types') ?: [],
  ];

  // Entity types (target).
  $form['track_enabled_target_entity_types'] = [
    '#type' => 'details',
    '#open' => FALSE,
    '#title' => $this
      ->t('Enabled target entity types'),
    '#description' => $this
      ->t('Check which entity types should be tracked when target.'),
    '#tree' => TRUE,
  ];
  $form['track_enabled_target_entity_types']['entity_types'] = [
    '#type' => 'checkboxes',
    '#title' => $this
      ->t('Target entity types'),
    '#options' => $entity_type_options,
    // If no custom settings exist, content entities are tracked by default.
    '#default_value' => $config
      ->get('track_enabled_target_entity_types') ?: array_keys($content_entity_types),
    '#required' => TRUE,
  ];

  // Edit warning message.
  $form['edit_warning_message_entity_types'] = [
    '#type' => 'details',
    '#open' => FALSE,
    '#title' => $this
      ->t('Warning message on edit form'),
    '#description' => $this
      ->t('Check which entity types should show a message when being edited with recorded references to it.'),
    '#tree' => TRUE,
  ];
  $form['edit_warning_message_entity_types']['entity_types'] = [
    '#type' => 'checkboxes',
    '#title' => $this
      ->t('Entity types to show warning on edit form'),
    '#options' => $entity_type_options,
    '#default_value' => $config
      ->get('edit_warning_message_entity_types') ?: [],
    '#required' => FALSE,
  ];

  // Delete warning message.
  $form['delete_warning_message_entity_types'] = [
    '#type' => 'details',
    '#open' => FALSE,
    '#title' => $this
      ->t('Warning message on delete form'),
    '#description' => $this
      ->t('Check which entity types should show a message when being deleted with recorded references to it.'),
    '#tree' => TRUE,
  ];
  $form['delete_warning_message_entity_types']['entity_types'] = [
    '#type' => 'checkboxes',
    '#title' => $this
      ->t('Entity types to show warning on delete form'),
    '#options' => $entity_type_options,
    '#default_value' => $config
      ->get('delete_warning_message_entity_types') ?: [],
    '#required' => FALSE,
  ];

  // Only allow to opt-in on target entities being tracked.
  foreach (array_keys($entity_type_options) as $entity_type_id) {
    $form['edit_warning_message_entity_types']['entity_types'][$entity_type_id]['#states'] = [
      'enabled' => [
        ':input[name="track_enabled_target_entity_types[entity_types][' . $entity_type_id . ']"]' => [
          'checked' => TRUE,
        ],
      ],
    ];
    $form['delete_warning_message_entity_types']['entity_types'][$entity_type_id]['#states'] = [
      'enabled' => [
        ':input[name="track_enabled_target_entity_types[entity_types][' . $entity_type_id . ']"]' => [
          'checked' => TRUE,
        ],
      ],
    ];
  }

  // Miscellaneous settings.
  $form['generic_settings'] = [
    '#type' => 'details',
    '#open' => TRUE,
    '#title' => $this
      ->t('Generic'),
  ];
  $form['generic_settings']['site_domains'] = [
    '#type' => 'textarea',
    '#title' => $this
      ->t('Domains for this website'),
    '#description' => $this
      ->t("A comma or new-line separated list of domain names for this website. Absolute URL's in content will be checked against these domains to allow usage tracking."),
    '#default_value' => implode("\r\n", $config
      ->get('site_domains') ?: []),
  ];
  $form['generic_settings']['usage_controller_items_per_page'] = [
    '#type' => 'number',
    '#title' => $this
      ->t('Items per page'),
    '#description' => $this
      ->t('Define here the number of items per page that should be shown on the usage page.'),
    '#default_value' => $config
      ->get('usage_controller_items_per_page') ?: ListUsageController::ITEMS_PER_PAGE_DEFAULT,
    '#min' => 1,
    '#step' => 1,
  ];
  return parent::buildForm($form, $form_state);
}