You are here

Home » API reference » Previous/Next API 8.2 » PrevNextConfigForm.php

class PrevNextConfigForm in Previous/Next API 8.2

Class PrevNextConfigForm.

@package Drupal\prev_next\Form

Hierarchy

Expanded class hierarchy of PrevNextConfigForm

1 string reference to 'PrevNextConfigForm'
prev_next.routing.yml in ./prev_next.routing.yml
prev_next.routing.yml

File

src/Form/PrevNextConfigForm.php, line 14

Namespace

Drupal\prev_next\Form
View source 
class PrevNextConfigForm extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('prev_next.settings');
    $form['batch_size'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Batch size'),
      '#description' => $this
        ->t('Number of nodes to index during each cron run.'),
      '#size' => 6,
      '#maxlength' => 7,
      '#default_value' => $config
        ->get('batch_size'),
      '#required' => TRUE,
    ];
    $form['node_type'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Content types'),
      '#description' => $this
        ->t('Define settings for each content type. If none of them is included, then all of them will be.'),
      '#open' => TRUE,
      '#tree' => TRUE,
    ];
    foreach (NodeType::loadMultiple() as $bundle) {
      $type = $bundle
        ->id();
      $bundle_config = \Drupal::configFactory()
        ->getEditable('prev_next.node_type.' . $type);
      $form['node_type'][$type] = [
        '#type' => 'details',
        '#title' => $bundle
          ->label(),
        '#description' => $this
          ->t('Note: changing one of these values will reset the entire Prev/Next index.'),
        '#open' => TRUE,
      ];
      $form['node_type'][$type]['include'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Include'),
        '#default_value' => $bundle_config
          ->get('include'),
      ];
      $form['node_type'][$type]['current'] = [
        '#type' => 'hidden',
        '#default_value' => $bundle_config
          ->get('current'),
      ];
      $form['node_type'][$type]['indexing_criteria'] = [
        '#title' => $this
          ->t('Indexing criteria'),
        '#type' => 'select',
        '#options' => [
          'nid' => $this
            ->t('Node ID'),
          'created' => $this
            ->t('Post date'),
          'changed' => $this
            ->t('Updated date'),
          'title' => $this
            ->t('Title'),
        ],
        '#default_value' => $bundle_config
          ->get('indexing_criteria'),
      ];
      $form['node_type'][$type]['indexing_criteria_current'] = [
        '#type' => 'hidden',
        '#value' => $bundle_config
          ->get('indexing_criteria_current'),
      ];
      $form['node_type'][$type]['same_type'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Only nodes with same content type'),
        '#default_value' => $bundle_config
          ->get('same_type'),
      ];
      $form['node_type'][$type]['same_type_current'] = [
        '#type' => 'hidden',
        '#default_value' => $bundle_config
          ->get('same_type_current'),
      ];
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('prev_next.settings')
      ->set('batch_size', $form_state
      ->getValue('batch_size'))
      ->save();

    // Save Node types settings.
    foreach ($form_state
      ->getValue('node_type') as $bundle => $values) {
      $bundle_config = \Drupal::configFactory()
        ->getEditable('prev_next.node_type.' . $bundle);
      $bundle_config
        ->set('include', $values['include'])
        ->set('current', $values['current'])
        ->set('indexing_criteria', $values['indexing_criteria'])
        ->set('indexing_criteria_current', $values['indexing_criteria_current'])
        ->set('same_type', $values['same_type'])
        ->set('same_type_current', $values['same_type_current'])
        ->save();
    }
    parent::submitForm($form, $form_state);
  }

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

}

Members

Namesort descending 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.
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.
PrevNextConfigForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
PrevNextConfigForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
PrevNextConfigForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
PrevNextConfigForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
PrevNextConfigForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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.