You are here

Home » API reference » JSON Web Token Authentication (JWT) 8 » ConfigForm.php

class ConfigForm in JSON Web Token Authentication (JWT) 8

Same name and namespace in other branches
  1. 8.0 src/Form/ConfigForm.php \Drupal\jwt\Form\ConfigForm

Class ConfigForm.

@package Drupal\jwt\Form

Hierarchy

Expanded class hierarchy of ConfigForm

1 string reference to 'ConfigForm'
jwt.routing.yml in ./jwt.routing.yml
jwt.routing.yml

File

src/Form/ConfigForm.php, line 17

Namespace

Drupal\jwt\Form
View source 
class ConfigForm extends ConfigFormBase {

  /**
   * The JWT transcoder.
   *
   * @var \Drupal\jwt\Transcoder\JwtTranscoder
   */
  protected $transcoder;

  /**
   * The key repository.
   *
   * @var \Drupal\key\KeyRepositoryInterface
   */
  protected $keyRepo;

  /**
   * ConfigForm constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   Config factory for parent.
   * @param \Drupal\key\KeyRepositoryInterface $key_repo
   *   Key repo to validate keys.
   * @param \Drupal\jwt\Transcoder\JwtTranscoder $transcoder
   *   JWT Transcoder.
   */
  public function __construct(ConfigFactoryInterface $config_factory, KeyRepositoryInterface $key_repo, JwtTranscoder $transcoder) {
    $this->keyRepo = $key_repo;
    $this->transcoder = $transcoder;
    parent::__construct($config_factory);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('key.repository'), $container
      ->get('jwt.transcoder'));
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'jwt.config',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'jwt_config_form';
  }

  /**
   * AJAX Function callback.
   *
   * @param array $form
   *   Drupal form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Drupal formstate object.
   *
   * @return mixed
   *   Updated AJAXed form.
   */
  public function ajaxCallback(array &$form, FormStateInterface $form_state) {
    return $form['key-container'];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['key-container'] = [
      '#type' => 'container',
      '#prefix' => '<div id="jwt-key-container">',
      '#suffix' => '</div>',
      '#weight' => 10,
    ];
    $form['jwt_algorithm'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Algorithm'),
      '#options' => $this->transcoder
        ->getAlgorithmOptions(),
      '#ajax' => [
        'callback' => '::ajaxCallback',
        'event' => 'change',
        'wrapper' => 'jwt-key-container',
        'progress' => [
          'type' => 'throbber',
        ],
      ],
      '#default_value' => $this
        ->config('jwt.config')
        ->get('algorithm'),
    ];
    if ($form_state
      ->isValueEmpty('jwt_algorithm')) {
      if (!empty($this
        ->config('jwt.config')
        ->get('algorithm'))) {
        $type = $this->transcoder
          ->getAlgorithmType($this
          ->config('jwt.config')
          ->get('algorithm'));
      }
      else {
        $type = 'jwt_hs';
      }
    }
    else {
      $type = $this->transcoder
        ->getAlgorithmType($form_state
        ->getValue('jwt_algorithm'));
    }
    $text = $type == 'jwt_hs' ? $this
      ->t('Secret') : $this
      ->t('Private Key');
    $form['key-container']['jwt_key'] = [
      '#type' => 'key_select',
      '#title' => $text,
      '#default_value' => $this
        ->config('jwt.config')
        ->get('key_id'),
      '#key_filters' => [
        'type' => $type,
      ],
      '#validated' => TRUE,
      '#required' => TRUE,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $algorithm = $form_state
      ->getValue('jwt_algorithm');
    $key_id = $form_state
      ->getValue('jwt_key');
    $key = $this->keyRepo
      ->getKey($key_id);
    if ($key != NULL && $key
      ->getKeyType()
      ->getPluginId() != $this->transcoder
      ->getAlgorithmType($algorithm)) {
      $form_state
        ->setErrorByName('jwt_key', $this
        ->t('Incorrect key type selected.'));
    }
    if ($key != NULL && $key
      ->getKeyType()
      ->getConfiguration()['algorithm'] != $algorithm) {
      $form_state
        ->setErrorByName('jwt_key', $this
        ->t('Key does not match algorithm selected.'));
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $values = $form_state
      ->getValues();
    if (isset($values['jwt_algorithm'])) {
      $this
        ->config('jwt.config')
        ->set('algorithm', $values['jwt_algorithm'])
        ->save();
    }
    if (isset($values['jwt_key'])) {
      $this
        ->config('jwt.config')
        ->set('key_id', $values['jwt_key'])
        ->save();
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigForm::$keyRepo protected property The key repository.
ConfigForm::$transcoder protected property The JWT transcoder.
ConfigForm::ajaxCallback public function AJAX Function callback.
ConfigForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
ConfigForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
ConfigForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
ConfigForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ConfigForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
ConfigForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
ConfigForm::__construct public function ConfigForm constructor. Overrides ConfigFormBase::__construct
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
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. 1
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. Overrides UrlGeneratorTrait::redirect
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.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
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.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
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. 1
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.