class SettingsForm in Pager Serializer 8

Configure example settings for this site.

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\pager_serializer\Form\SettingsForm

Expanded class hierarchy of SettingsForm

1 string reference to 'SettingsForm'

pager_serializer.routing.yml in ./pager_serializer.routing.yml: pager_serializer.routing.yml

File

src/Form/SettingsForm.php, line 12

Namespace

Drupal\pager_serializer\Form

View source

class SettingsForm extends ConfigFormBase {

  /**
   * Config settings.
   *
   * @var string
   */
  const SETTINGS = 'pager_serializer.settings';

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      static::SETTINGS,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config(static::SETTINGS);
    $form['rows_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Rows'),
      '#default_value' => $config
        ->get('rows_label'),
      '#description' => $this
        ->t('Set the property name the default results will be returned as. Defaults to <em>:rows</em>', [
        ':rows' => 'rows',
      ]),
      '#required' => TRUE,
    ];
    $form['pager_object_enabled'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Include a pagination object.'),
      '#description' => $this
        ->t('Pagination data will be attached to the main response object if this is unchecked.'),
      '#default_value' => $config
        ->get('pager_object_enabled'),
    ];
    $form['pager_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Pager'),
      '#default_value' => $config
        ->get('pager_label'),
      '#description' => $this
        ->t('Set the property name the paginiation data will be returned as. Defaults to <em>:pager</em>', [
        ':pager' => 'pager',
      ]),
      '#required' => TRUE,
      '#states' => [
        'visible' => [
          ':input[name="pager_object_enabled"][value="1"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['pager_fieldset'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Pager Settings'),
    ];
    $form['pager_fieldset']['current_page'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Current Page'),
    ];
    $form['pager_fieldset']['current_page']['current_page_enabled'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable'),
      '#default_value' => $config
        ->get('current_page_enabled'),
    ];
    $form['pager_fieldset']['current_page']['current_page_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Property'),
      '#default_value' => $config
        ->get('current_page_label'),
      '#required' => TRUE,
      '#states' => [
        'visible' => [
          ':input[name="current_page_enabled"][value="1"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['pager_fieldset']['total_items'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Total Items'),
    ];
    $form['pager_fieldset']['total_items']['total_items_enabled'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable'),
      '#default_value' => $config
        ->get('total_items_enabled'),
    ];
    $form['pager_fieldset']['total_items']['total_items_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Property'),
      '#default_value' => $config
        ->get('total_items_label'),
      '#required' => TRUE,
      '#states' => [
        'visible' => [
          ':input[name="total_items_enabled"][value="1"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['pager_fieldset']['total_pages'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Total Pages'),
    ];
    $form['pager_fieldset']['total_pages']['total_pages_enabled'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable'),
      '#default_value' => $config
        ->get('total_pages_enabled'),
    ];
    $form['pager_fieldset']['total_pages']['total_pages_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Property'),
      '#default_value' => $config
        ->get('total_pages_label'),
      '#required' => TRUE,
      '#states' => [
        'visible' => [
          ':input[name="total_pages_enabled"][value="1"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['pager_fieldset']['items_per_page'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Items Pre Page'),
    ];
    $form['pager_fieldset']['items_per_page']['items_per_page_enabled'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable'),
      '#default_value' => $config
        ->get('items_per_page_enabled'),
    ];
    $form['pager_fieldset']['items_per_page']['items_per_page_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Property'),
      '#default_value' => $config
        ->get('items_per_page_label'),
      '#required' => TRUE,
      '#states' => [
        'visible' => [
          ':input[name="items_per_page_enabled"][value="1"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $build = parent::buildForm($form, $form_state);
    $build['actions']['reset'] = [
      '#title' => $this
        ->t('Reset'),
      '#type' => 'link',
      '#url' => Url::fromRoute('pager_serializer.settings.reset'),
    ];
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Retrieve the configuration.
    $this->configFactory
      ->getEditable(static::SETTINGS)
      ->set('rows_label', $form_state
      ->getValue('rows_label'))
      ->set('pager_label', $form_state
      ->getValue('pager_label'))
      ->set('pager_object_enabled', $form_state
      ->getValue('pager_object_enabled'))
      ->set('current_page_enabled', $form_state
      ->getValue('current_page_enabled'))
      ->set('current_page_label', $form_state
      ->getValue('current_page_label'))
      ->set('total_items_enabled', $form_state
      ->getValue('total_items_enabled'))
      ->set('total_items_label', $form_state
      ->getValue('total_items_label'))
      ->set('total_pages_enabled', $form_state
      ->getValue('total_pages_enabled'))
      ->set('total_pages_label', $form_state
      ->getValue('total_pages_label'))
      ->set('items_per_page_enabled', $form_state
      ->getValue('items_per_page_enabled'))
      ->set('items_per_page_label', $form_state
      ->getValue('items_per_page_label'))
      ->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.
SettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
SettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
SettingsForm::SETTINGS		constant	Config settings.
SettingsForm::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 SettingsForm in Pager Serializer 8

Hierarchy

File

Namespace

Members

API Navigation