class Select2BoxesConfigForm in Select2 Boxes 8

Class Select2BoxesConfigForm.

@package Drupal\select2boxes\Form

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\select2boxes\Form\Select2BoxesConfigForm

Expanded class hierarchy of Select2BoxesConfigForm

1 string reference to 'Select2BoxesConfigForm'

select2boxes.routing.yml in ./select2boxes.routing.yml: select2boxes.routing.yml

File

src/Form/Select2BoxesConfigForm.php, line 13

Namespace

Drupal\select2boxes\Form

View source

class Select2BoxesConfigForm extends ConfigFormBase {

  /**
   * List of allowed versions of Select2 library.
   *
   * @var array
   */
  protected static $allowedVersions = [
    '4.0.1',
    '4.0.2',
    '4.0.3',
    '4.0.4',
    '4.0.5',
  ];

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $conf = $this
      ->config($this
      ->getEditableConfigNames()[0]);
    $versions = array_combine(static::$allowedVersions, static::$allowedVersions);
    $providers = [
      'cdn' => 'CDN',
    ];

    // Setting configurations.
    // Global widget configurations.
    $form['global_options'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Global settings'),
      '#open' => TRUE,
      '#group' => 'container',
    ];
    $form['global_options']['select2_global'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable select2 widgets for all dropdown and multiselect lists'),
      '#default_value' => $conf
        ->get('select2_global'),
    ];
    $form['global_options']['disable_for_admin_pages'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Disable select2 widgets for admin pages'),
      '#default_value' => $conf
        ->get('disable_for_admin_pages'),
      '#states' => [
        'visible' => [
          ":input[name=\"select2_global\"]" => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['global_options']['limited_search'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Limit search box visibility by list length'),
      '#default_value' => $conf
        ->get('limited_search'),
    ];
    $form['global_options']['minimum_search_length'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Minimum list length'),
      '#default_value' => $conf
        ->get('minimum_search_length'),
      '#states' => [
        'visible' => [
          ":input[name=\"limited_search\"]" => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];

    // Library configurations.
    $form['library'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Library'),
      '#open' => TRUE,
      '#group' => 'container',
    ];
    $form['library']['provider'] = [
      '#type' => 'select',
      '#options' => $providers,
      '#title' => $this
        ->t('Select2 library provider'),
      '#default_value' => $conf
        ->get('provider'),
    ];
    $form['library']['version'] = [
      '#type' => 'select',
      '#options' => $versions,
      '#title' => $this
        ->t('Version'),
      '#default_value' => $conf
        ->get('version'),
    ];
    $form['library']['url'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Select2 CDN URL'),
      '#description' => $this
        ->t('It is best to use https protocols here as it will allow more flexibility if the need ever arises'),
      '#default_value' => $conf
        ->get('url'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $fields = [
      'limited_search',
      'select2_global',
      'disable_for_admin_pages',
      'minimum_search_length',
      'provider',
      'version',
      'url',
    ];
    $editable = $this->configFactory
      ->getEditable($this
      ->getEditableConfigNames()[0]);
    foreach ($fields as $value) {
      if ($form_state
        ->hasValue($value)) {
        $editable
          ->set($value, $form_state
          ->getValue($value));
      }
    }
    $editable
      ->save();
    parent::submitForm($form, $form_state);
  }

}

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
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.
Select2BoxesConfigForm::$allowedVersions	protected static	property	List of allowed versions of Select2 library.
Select2BoxesConfigForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
Select2BoxesConfigForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
Select2BoxesConfigForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
Select2BoxesConfigForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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.

You are here

class Select2BoxesConfigForm in Select2 Boxes 8

Hierarchy

File

Namespace

Members

API Navigation