class LtiToolProviderRolesSettingsForm in LTI Tool Provider 2.x

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
    • class \Drupal\lti_tool_provider_roles\Form\LtiToolProviderRolesSettingsForm

1 string reference to 'LtiToolProviderRolesSettingsForm'

lti_tool_provider_roles.routing.yml in modules/lti_tool_provider_roles/lti_tool_provider_roles.routing.yml

modules/lti_tool_provider_roles/lti_tool_provider_roles.routing.yml

File

modules/lti_tool_provider_roles/src/Form/LtiToolProviderRolesSettingsForm.php, line 8

Namespace

Drupal\lti_tool_provider_roles\Form

class LtiToolProviderRolesSettingsForm extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $filter = '') : array {
    $settings = $this
      ->config('lti_tool_provider_roles.settings');
    $mapped_roles = $settings
      ->get('mapped_roles');
    $lti_roles = $this
      ->config('lti_tool_provider.settings')
      ->get('lti_roles');
    $form['mapped_roles'] = [
      '#type' => 'table',
      '#tree' => TRUE,
      '#caption' => t('This page allows you to map LTI roles to Drupal user roles. This is applied every time a user logs in via LTI. Please note that if roles are mapped and they are not present on the LMS, they will be removed from the Drupal user. Please be careful when setting this for the authenticated user role.'),
      '#header' => [
        t('User Role'),
        t('LTI Role'),
      ],
    ];
    foreach (user_roles(TRUE) as $key => $user_role) {
      $form['mapped_roles'][$key] = [
        'user_role' => [
          '#type' => 'item',
          '#title' => $user_role
            ->label(),
        ],
        'lti_role' => [
          '#type' => 'select',
          '#required' => FALSE,
          '#empty_option' => t('None'),
          '#empty_value' => TRUE,
          '#default_value' => $mapped_roles[$key],
          '#options' => array_combine($lti_roles, $lti_roles),
        ],
      ];
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $settings = $this
      ->config('lti_tool_provider_roles.settings');
    $lti_roles = $this
      ->config('lti_tool_provider.settings')
      ->get('lti_roles');
    $mapped_roles = [];
    foreach ($form_state
      ->getValue('mapped_roles') as $key => $value) {
      if (in_array($value['lti_role'], $lti_roles)) {
        $mapped_roles[$key] = $value['lti_role'];
      }
    }
    $settings
      ->set('mapped_roles', $mapped_roles)
      ->save();
  }

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

}

Members

Name	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.
LtiToolProviderRolesSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
LtiToolProviderRolesSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
LtiToolProviderRolesSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
LtiToolProviderRolesSettingsForm::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.