You are here

class NodeAccessRebuildProgressiveSettingsForm in Node Access Rebuild Progressive 8

Same name and namespace in other branches
  1. 2.x src/Form/NodeAccessRebuildProgressiveSettingsForm.php \Drupal\node_access_rebuild_progressive\Form\NodeAccessRebuildProgressiveSettingsForm

Configure settings for our module.

Hierarchy

Expanded class hierarchy of NodeAccessRebuildProgressiveSettingsForm

1 string reference to 'NodeAccessRebuildProgressiveSettingsForm'
node_access_rebuild_progressive.routing.yml in ./node_access_rebuild_progressive.routing.yml
node_access_rebuild_progressive.routing.yml

File

src/Form/NodeAccessRebuildProgressiveSettingsForm.php, line 11

Namespace

Drupal\node_access_rebuild_progressive\Form
View source
class NodeAccessRebuildProgressiveSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('node_access_rebuild_progressive.settings');
    $form['cron'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable progressive node access rebuild at cron time'),
      '#description' => $this
        ->t('It is recommended that you run cron via drush for using this feature.'),
      '#default_value' => $config
        ->get('cron'),
    ];
    $form['chunk'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Number of nodes to process in each chunk'),
      '#default_value' => $config
        ->get('chunk'),
      '#description' => $this
        ->t('The number of nodes that will be processed per cron run. Make sure it can safely fit in memory, and in the cron run time if you are not running cron via drush.'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $chunk_size = $form_state
      ->getValue('chunk');
    if (!is_numeric($chunk_size) || $chunk_size <= 0) {
      $form_state
        ->setErrorByName('chunk', $this
        ->t('Chunk size must be a positive integer.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    \Drupal::configFactory()
      ->getEditable('node_access_rebuild_progressive.settings')
      ->set('chunk', $form_state
      ->getValue('chunk'))
      ->set('cron', $form_state
      ->getValue('cron'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

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