You are here

Home » API reference » LTI Tool Provider 2.x » LtiToolProviderProvisionSettingsForm.php

class LtiToolProviderProvisionSettingsForm in LTI Tool Provider 2.x

Same name and namespace in other branches
  1. 8 modules/lti_tool_provider_provision/src/Form/LtiToolProviderProvisionSettingsForm.php \Drupal\lti_tool_provider_provision\Form\LtiToolProviderProvisionSettingsForm

Hierarchy

Expanded class hierarchy of LtiToolProviderProvisionSettingsForm

1 string reference to 'LtiToolProviderProvisionSettingsForm'
lti_tool_provider_provision.routing.yml in modules/lti_tool_provider_provision/lti_tool_provider_provision.routing.yml
modules/lti_tool_provider_provision/lti_tool_provider_provision.routing.yml

File

modules/lti_tool_provider_provision/src/Form/LtiToolProviderProvisionSettingsForm.php, line 10

Namespace

Drupal\lti_tool_provider_provision\Form
View source 
class LtiToolProviderProvisionSettingsForm extends ConfigFormBase {

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $filter = '') : array {
    $settings = $this
      ->config('lti_tool_provider_provision.settings');
    $lti_roles = $this
      ->config('lti_tool_provider.settings')
      ->get('lti_roles');
    $entityType = $form_state
      ->getValue('entity_type') ? $form_state
      ->getValue('entity_type') : $settings
      ->get('entity_type');
    $entityBundle = $form_state
      ->getValue('entity_bundle') ? $form_state
      ->getValue('entity_bundle') : $settings
      ->get('entity_bundle');
    $entityRedirect = $form_state
      ->getValue('entity_redirect') ? $form_state
      ->getValue('entity_redirect') : $settings
      ->get('entity_redirect');
    $entityDefaults = $form_state
      ->getValue('entity_defaults') ? $form_state
      ->getValue('entity_defaults') : $settings
      ->get('entity_defaults');
    $entitySync = $form_state
      ->getValue('entity_sync') ? $form_state
      ->getValue('entity_sync') : $settings
      ->get('entity_sync');
    $allowedRolesEnabled = $form_state
      ->getValue('allowed_roles_enabled') ? $form_state
      ->getValue('allowed_roles_enabled') : $settings
      ->get('allowed_roles_enabled');
    $allowedRoles = $form_state
      ->getValue('allowed_roles') ? $form_state
      ->getValue('allowed_roles') : $settings
      ->get('allowed_roles');
    $form['#attributes']['id'] = uniqid($this
      ->getFormId());
    $options = [];
    $definitions = Drupal::entityTypeManager()
      ->getDefinitions();
    foreach ($definitions as $definition) {
      if ($definition instanceof ContentEntityType) {
        $options[$definition
          ->id()] = $definition
          ->getLabel();
      }
    }
    $form['entity_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Default entity type'),
      '#description' => $this
        ->t('Select the entity type to use as the default entity provision.'),
      '#default_value' => $entityType,
      '#empty_value' => '',
      '#empty_option' => '- Select an entity type -',
      '#options' => $options,
      '#ajax' => [
        'callback' => '::getEntityBundles',
        'event' => 'change',
        'wrapper' => $form['#attributes']['id'],
        'progress' => [
          'type' => 'throbber',
        ],
      ],
    ];
    if ($entityType) {
      $options = [];
      $bundles = Drupal::service('entity_type.bundle.info')
        ->getBundleInfo($entityType);
      foreach ($bundles as $key => $bundleInfo) {
        $options[$key] = $bundleInfo['label'];
      }
      $form['entity_bundle'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Default entity bundle'),
        '#description' => $this
          ->t('Select the entity bundle to use as the default entity provision.'),
        '#default_value' => $entityBundle,
        '#empty_value' => '',
        '#empty_option' => '- Select an entity type -',
        '#options' => $options,
        '#ajax' => [
          'callback' => '::getEntityBundles',
          'event' => 'change',
          'wrapper' => $form['#attributes']['id'],
          'progress' => [
            'type' => 'throbber',
          ],
        ],
      ];
    }
    $form['entity_redirect'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Always redirect to entity upon launch.'),
      '#default_value' => $entityRedirect,
    ];
    if ($entityBundle) {
      $lti_launch = $this
        ->config('lti_tool_provider.settings')
        ->get('lti_launch');
      $form['entity_defaults'] = [
        '#type' => 'fieldset',
        '#title' => 'Entity defaults',
        '#tree' => TRUE,
      ];

      /* @var $entityManager Drupal\Core\Entity\EntityFieldManagerInterface */
      $entityManager = Drupal::service('entity_field.manager');
      $userFieldDefinitions = $entityManager
        ->getFieldDefinitions($entityType, $entityBundle);
      foreach ($userFieldDefinitions as $key => $field) {
        $type = $field
          ->getType();
        if ($type === 'string') {
          $form['entity_defaults'][$key] = [
            'name' => [
              '#type' => 'item',
              '#title' => $field
                ->getLabel(),
            ],
            'lti_attribute' => [
              '#type' => 'select',
              '#required' => FALSE,
              '#empty_option' => t('None'),
              '#empty_value' => TRUE,
              '#default_value' => $entityDefaults[$key],
              '#options' => array_combine($lti_launch, $lti_launch),
            ],
          ];
        }
      }
      $form['entity_sync'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Always sync entity fields from context during launch.'),
        '#default_value' => $entitySync,
      ];
    }
    $form['allowed_roles_enabled'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Restrict entity provision to specific LTI roles.'),
      '#default_value' => $allowedRolesEnabled,
    ];
    $form['allowed_roles'] = [
      '#type' => 'details',
      '#title' => 'Allowed Roles',
      '#description' => $this
        ->t('If enabled above, allow only specific LTI roles to provision entities.'),
      '#tree' => TRUE,
      '#open' => FALSE,
    ];
    foreach ($lti_roles as $ltiRole) {
      $form['allowed_roles'][$ltiRole] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t($ltiRole),
        '#default_value' => $allowedRoles[$ltiRole],
      ];
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() : string {
    return 'lti_tool_provider_provision_settings';
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $settings = $this
      ->config('lti_tool_provider_provision.settings');
    $lti_launch = $this
      ->config('lti_tool_provider.settings')
      ->get('lti_launch');
    $entityType = $form_state
      ->getValue('entity_type');
    $entityBundle = $form_state
      ->getValue('entity_bundle');
    $entityRedirect = $form_state
      ->getValue('entity_redirect');
    $entitySync = $form_state
      ->getValue('entity_sync');
    $allowedRolesEnabled = $form_state
      ->getValue('allowed_roles_enabled');
    $settings
      ->set('entity_type', $entityType)
      ->save();
    $settings
      ->set('entity_bundle', $entityBundle)
      ->save();
    $settings
      ->set('entity_redirect', $entityRedirect)
      ->save();
    $settings
      ->set('entity_sync', $entitySync)
      ->save();
    $settings
      ->set('allowed_roles_enabled', $allowedRolesEnabled)
      ->save();
    $entityDefaults = [];
    foreach ($form_state
      ->getValue('entity_defaults') as $key => $value) {
      if (in_array($value['lti_attribute'], $lti_launch)) {
        $entityDefaults[$key] = $value['lti_attribute'];
      }
    }
    $settings
      ->set('entity_defaults', $entityDefaults)
      ->save();
    $allowedRoles = [];
    foreach ($form_state
      ->getValue('allowed_roles') as $key => $value) {
      $allowedRoles[$key] = $value;
    }
    $settings
      ->set('allowed_roles', $allowedRoles)
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * @param array $form
   *
   * @return array
   */
  public function getEntityBundles(array $form) : array {
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() : array {
    return [
      'lti_tool_provider_provision.settings',
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 18
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 16
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::configFactory protected function Gets the config factory for this form. 3
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route.
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 72
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
LtiToolProviderProvisionSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
LtiToolProviderProvisionSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
LtiToolProviderProvisionSettingsForm::getEntityBundles public function
LtiToolProviderProvisionSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
LtiToolProviderProvisionSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.