private function FormManglerService::addTcaSettingsToForm in Token Content Access 8

Same name and namespace in other branches

2.0.x src/FormManglerService.php \Drupal\tca\FormManglerService::addTcaSettingsToForm()

Common functionality for adding TCA options to forms.

Parameters

array $attach: The form that the TCA form should be attached to.

string $entity_type_id: The string ID of the entity type for the form, e.g. 'node'.

object $entity: The entity that we're adding the form to, e.g. a node. This should be defined even in the case of bundles since it is used to determine bundle and entity type.

string|int|object $form_state: The form state.

string $form_id: The form id.

1 call to FormManglerService::addTcaSettingsToForm()

FormManglerService::addTcaSettingsToEntityForm in src/FormManglerService.php: Form structure for the TCA configuration.

File

src/FormManglerService.php, line 99

Class

FormManglerService: Class FormManglerService.

Namespace

Drupal\tca

Code

private function addTcaSettingsToForm(array &$attach, $entity_type_id, $entity, FormStateInterface $form_state, $form_id) {
  $entity_type = $this->entityTypeManager
    ->getStorage($entity_type_id)
    ->getEntityType();
  $is_entity_viewable = $this->entityTypeManager
    ->getDefinition($entity_type_id)
    ->hasViewBuilderClass();

  // TRUE if an entity such as node_type.
  $is_entity_bundle = $this
    ->isEntityBundle($entity);
  $entity_id = $entity
    ->id();
  $tca_bundle_settings = NULL;
  $tca_settings = NULL;
  $active = NULL;
  $token = NULL;

  // TCA for entity bundles such as node_type.
  if ($is_entity_bundle) {

    // Load TCA settings for entity.
    $tca_settings = $this->tcaSettingsManager
      ->loadSettingsAsConfig($entity_type_id, $entity_id);
    $active = $tca_settings
      ->get('active');
    $forced = $tca_settings
      ->get('force') ?? FALSE;
  }
  else {
    $bundle_entity_type_id = $entity_type
      ->getBundleEntityType() ?: $entity_type_id;
    $bundle_entity_id = $entity
      ->getEntityType()
      ->getBundleEntityType() ? $entity
      ->bundle() : NULL;

    // Load TCA settings for entity bundle.
    $tca_bundle_settings = $this->tcaSettingsManager
      ->loadSettingsAsConfig($bundle_entity_type_id, $bundle_entity_id);

    // If the form is about to be attached to an entity,
    // but the bundle isn't allowed to be overridden, exit.
    if (!$tca_bundle_settings
      ->get('active')) {
      return;
    }

    // Load TCA settings for entity.
    $tca_settings = $this->tcaSettingsManager
      ->loadSettingsAsConfig($entity_type_id, $entity_id);
    $active = $tca_settings
      ->get('active');
    $forced = $tca_bundle_settings
      ->get('force') ?? FALSE;
    $token = $tca_settings
      ->get('token');
  }
  $entity_plugin = $this->tcaPluginManager
    ->createInstanceByEntityType($is_entity_bundle && !empty($entity_type
    ->getBundleOf()) ? $entity_type
    ->getBundleOf() : $entity_type_id);
  $form = [];

  // Wrap everything in a fieldset.
  $form['tca'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Token Content Access settings'),
    '#open' => $active ? TRUE : FALSE,
    // TODO: Should probably handle group in a plugin - not sure if, e.g.,
    // files will work in the same way and even if they do later entities
    // might not.
    '#group' => $is_entity_bundle ? 'additional_settings' : 'advanced',
    '#attributes' => [
      'class' => [
        'tca-settings-form',
      ],
    ],
    '#tree' => FALSE,
  ];
  $form['tca']['tca_is_entity_bundle'] = [
    '#type' => 'value',
    '#value' => $is_entity_bundle,
  ];
  $form['tca']['tca_entity_type_id'] = [
    '#type' => 'value',
    '#value' => $entity_type_id,
  ];
  $form['tca']['tca_entity_id'] = [
    '#type' => 'value',
    '#value' => $entity_id,
  ];
  $form['tca']['tca_active'] = [
    '#type' => 'checkbox',
    '#title' => t('Enable Token Content Access protection'),
    '#default_value' => $forced ?: $active,
    '#description' => t('If this is checked, users with the Administer Token Content Access settings permission will be able to enable Token Content Access protection for individual entities.'),
  ];

  // Override setting if we're not editing a bundle and entity is viewable.
  if (!$is_entity_bundle && $is_entity_viewable) {
    $entity_url = !$entity
      ->isNew() ? $entity
      ->toUrl('canonical', [
      'query' => [
        'tca' => $token,
      ],
      'absolute' => TRUE,
    ])
      ->toString() : t('N/A');
    $form['tca']['tca_active']['#description'] = t('Prevent users from viewing this content without providing an access token via the URL.');
    $form['tca']['tca_active']['#disabled'] = $forced;
    $states = [
      'visible' => [
        ':input[name="tca_active"]' => [
          'checked' => TRUE,
        ],
      ],
    ];

    // Allows content to be viewed without the "View published content"
    // permission.
    $form['tca']['tca_public'] = [
      '#type' => 'checkbox',
      '#title' => t('All users with access token can view this content'),
      '#default_value' => $tca_settings
        ->get('public'),
      '#description' => t('Allow all users to view this content bypassing any permissions restrictions.'),
      '#states' => $states,
    ];
    $form['tca']['tca_token'] = [
      '#type' => 'textfield',
      '#title' => t('Access Token'),
      '#default_value' => $token,
      '#description' => t('Append this access token to the URL as the value for the "tca" query parameter.'),
      '#attributes' => [
        'readonly' => 'readonly',
      ],
      '#states' => $states,
    ];

    // Attach clipboard functionality.
    $module_handler = \Drupal::service('module_handler');
    if ($module_handler
      ->moduleExists('clipboardjs')) {
      $form['tca']['#attached']['library'][] = 'clipboardjs/clipboardjs';
      $form['tca']['tca_clipboardjs'] = [
        '#type' => 'textfield',
        '#theme' => 'clipboardjs',
        '#text' => $entity_url,
        '#alert_text' => NULL,
        '#disabled' => TRUE,
        '#access' => !empty($token),
        '#states' => $states,
      ];
    }
    $form['tca']['tca_url_copy'] = [
      '#type' => 'item',
      '#title' => t('URL to copy'),
      '#markup' => '<span>' . $entity_url . '</span>',
      '#access' => !empty($token),
      '#states' => $states,
    ];
    $form['tca']['actions'] = [
      '#type' => 'actions',
    ];
    $form['tca']['actions']['tca_regenerate'] = [
      '#type' => 'submit',
      '#value' => t('Generate a new Access Token'),
      '#access' => !empty($token),
      '#ajax' => [
        'callback' => [
          'Drupal\\tca\\FormManglerService',
          'staticHandleFormAjax',
        ],
      ],
      '#submit' => [
        [
          'Drupal\\tca\\FormManglerService',
          'staticHandleFormSubmit',
        ],
      ],
      '#states' => $states,
    ];
  }

  // Add "forced" settings to bundle form.
  if ($is_entity_bundle) {
    $states = [
      'visible' => [
        ':input[name="tca_active"]' => [
          'checked' => TRUE,
        ],
      ],
    ];

    // Add force checkbox.
    $form['tca']['tca_force'] = [
      '#type' => 'checkbox',
      '#title' => t('Enforce Token usage'),
      '#default_value' => $forced,
      '#description' => t('Enforce usage of Tokens on this bundle.'),
      '#states' => $states,
    ];
  }

  // Attach the TCA form to the main form, and add a custom validation
  // callback.
  $attach += $form;

  // Optionally provide a form validation handler.
  $submit_handler_locations = $is_entity_bundle ? $entity_plugin
    ->getBundleFormSubmitHandlerAttachLocations() : $entity_plugin
    ->getFormSubmitHandlerAttachLocations();
  foreach ($submit_handler_locations as $location) {
    $array_ref =& $attach;
    if (is_array($location)) {
      foreach ($location as $subkey) {
        $array_ref =& $array_ref[$subkey];
      }
    }
    else {
      $array_ref =& $array_ref[$location];
    }
    if (isset($array_ref)) {
      $array_ref[] = [
        'Drupal\\tca\\FormManglerService',
        'staticHandleFormSubmit',
      ];
    }
  }
}

You are here