class KeyAuthSettingsForm in Key auth 8

Class KeyAuthSettingsForm.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
    • class \Drupal\key_auth\Form\KeyAuthSettingsForm

1 string reference to 'KeyAuthSettingsForm'

key_auth.routing.yml in ./key_auth.routing.yml

key_auth.routing.yml

File

src/Form/KeyAuthSettingsForm.php, line 12

Namespace

Drupal\key_auth\Form

class KeyAuthSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('key_auth.settings');
    $form['auto_generate_keys'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Automatically generate a key when users are created'),
      '#default_value' => $config
        ->get('auto_generate_keys'),
      '#description' => $this
        ->t('This applies only to new users that have access to use key authentication.'),
    ];
    $form['key_length'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Key length'),
      '#default_value' => $config
        ->get('key_length'),
      '#min' => 8,
      '#max' => 255,
      '#required' => TRUE,
      '#description' => $this
        ->t('Existing keys will not be affected.'),
    ];
    $form['param_name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Parameter name'),
      '#default_value' => $config
        ->get('param_name'),
      '#required' => TRUE,
      '#description' => $this
        ->t('The name of the parameter used to send the API key via one of the selected detection methods below.'),
    ];
    $form['detection_methods'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Detection methods'),
      '#default_value' => $config
        ->get('detection_methods'),
      '#required' => TRUE,
      '#options' => [
        KeyAuth::DETECTION_METHOD_HEADER => $this
          ->t('Header'),
        KeyAuth::DETECTION_METHOD_QUERY => $this
          ->t('Query'),
      ],
      '#description' => $this
        ->t('Select one or more methods of detecting the API key.'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $this
      ->config('key_auth.settings')
      ->set('auto_generate_keys', (bool) $form_state
      ->getValue('auto_generate_keys'))
      ->set('key_length', $form_state
      ->getValue('key_length'))
      ->set('param_name', $form_state
      ->getValue('param_name'))
      ->set('detection_methods', array_values($form_state
      ->getValue('detection_methods')))
      ->save();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create	13
ConfigFormBase::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object.	11
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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
KeyAuthSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
KeyAuthSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
KeyAuthSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
KeyAuthSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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.