You are here

Home » API reference » DB Maintenance 8 » DbMaintenanceAdminSettings.php

class DbMaintenanceAdminSettings in DB Maintenance 8

Same name and namespace in other branches
  1. 8.2 src/Form/DbMaintenanceAdminSettings.php \Drupal\db_maintenance\Form\DbMaintenanceAdminSettings
  2. 2.0.x src/Form/DbMaintenanceAdminSettings.php \Drupal\db_maintenance\Form\DbMaintenanceAdminSettings

Hierarchy

Expanded class hierarchy of DbMaintenanceAdminSettings

1 string reference to 'DbMaintenanceAdminSettings'
db_maintenance.routing.yml in ./db_maintenance.routing.yml
db_maintenance.routing.yml

File

src/Form/DbMaintenanceAdminSettings.php, line 22
Contains \Drupal\db_maintenance\Form\DbMaintenanceAdminSettings.

Namespace

Drupal\db_maintenance\Form
View source 
class DbMaintenanceAdminSettings extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('db_maintenance.settings');
    foreach (Element::children($form) as $variable) {
      $config
        ->set($variable, $form_state
        ->getValue($form[$variable]['#parents']));
    }
    $config
      ->save();
    if (method_exists($this, '_submitForm')) {
      $this
        ->_submitForm($form, $form_state);
    }
    parent::submitForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'db_maintenance.settings',
    ];
  }
  public function buildForm(array $form, FormStateInterface $form_state) {
    $dbs = DbHandler::getDatabases();

    // drupal_add_css(drupal_get_path('module', 'db_maintenance') . '/db_maintenance.css');
    //    $form = [];
    $form['write_log'] = [
      '#type' => 'checkbox',
      '#title' => 'Log OPTIMIZE queries',
      //'#default_value' => \Drupal::config('db_maintenance.settings')->get('write_log'),
      '#default_value' => ConfigHandler::getWriteLog(),
      '#description' => t('If enabled, a watchdog entry will be made each time tables are optimized, containing information which tables were involved.'),
    ];
    $options = [
      0 => t('Run during every cron'),
      3600 => t('Hourly'),
      7200 => t('Bi-Hourly'),
      86400 => t('Daily'),
      172800 => t('Bi-Daily'),
      604800 => t('Weekly'),
      1209600 => t('Bi-Weekly'),
      2592000 => t('Monthly'),
      5184000 => t('Bi-Monthly'),
    ];
    $url = Url::fromRoute('db_maintenance.optimize_tables_page');
    $token = \Drupal::csrfToken()
      ->get($url
      ->getInternalPath());
    $url
      ->setOptions([
      'absolute' => TRUE,
      'query' => [
        'token' => $token,
      ],
    ]);
    $internal_link = Link::fromTextAndUrl(t('Optimize now.'), $url)
      ->toString();
    $form['cron_frequency'] = [
      '#type' => 'select',
      '#title' => t('Optimize tables'),
      '#options' => $options,
      '#default_value' => ConfigHandler::getCronFrequency(),
      '#description' => t('Select how often database tables should be optimized.') . ' ' . $internal_link,
    ];

    // Set the databases array if not already set in $db_url.
    $options = [];

    // Visibility.
    $states1 = array(
      'visible' => array(
        ':input[name="use_time_interval"]' => array(
          'checked' => TRUE,
        ),
      ),
    );
    $form['use_time_interval'] = array(
      '#type' => 'checkbox',
      '#title' => t('Use time interval'),
      '#default_value' => ConfigHandler::getUseTimeInterval(),
      '#description' => t('Start optimization only within predefined time interval.'),
    );
    $form['time_interval_start'] = array(
      '#type' => 'textfield',
      '#maxlength' => 25,
      '#title' => t('Time interval start'),
      '#default_value' => ConfigHandler::getTimeIntervalStart(),
      '#description' => t('Time interval start in 24 hour format H:i (HH:MM) like 23:30 or 01:00.'),
      '#states' => $states1,
    );
    $form['time_interval_end'] = array(
      '#type' => 'textfield',
      '#maxlength' => 25,
      '#title' => t('Time interval end'),
      '#default_value' => ConfigHandler::getTimeIntervalEnd(),
      '#description' => t('Time interval end in 24 hour format H:i (HH:MM) like 23:30 or 01:00.'),
      '#states' => $states1,
    );

    // Visibility.
    $states = [
      'visible' => [
        ':input[name="all_tables"]' => [
          'checked' => FALSE,
        ],
      ],
    ];
    $form['all_tables'] = [
      '#type' => 'checkbox',
      '#title' => t('Optimize all tables'),
      '#default_value' => ConfigHandler::getProcessAllTables(),
      '#description' => t('Automatically optimize all tables in the database(s) without having to select them first.'),
    ];

    // Loop through each database and list the possible tables to optimize.
    foreach ($dbs as $db => $connection) {
      $options = DbHandler::listTables($db);
      $form['table_list_' . $connection['default']['database']] = [
        '#type' => 'select',
        '#title' => t('Tables in the @db database', [
          '@db' => $connection['default']['database'] == 'default' ? 'Drupal' : $connection['default']['database'],
        ]),
        '#options' => $options,
        '#default_value' => ConfigHandler::getTableList($connection['default']['database'], ''),
        '#description' => t('Selected tables will be optimized during cron runs.'),
        '#multiple' => TRUE,
        '#attributes' => [
          'size' => 17,
        ],
        '#states' => $states,
      ];
    }
    return parent::buildForm($form, $form_state);
  }

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

    // Check time interval.
    if ($form_state
      ->getValue('use_time_interval') == TRUE) {

      // Check start value.
      $time = $form_state
        ->getValue('time_interval_start');
      if (!IntervalHandler::checkTime($time)) {
        $form_state
          ->setErrorByName('time_interval_start', $this
          ->t('Invalid time format. Should be 24 hour format H:i (HH:MM) like 23:30 or 01:00.'));
      }

      // Check end value.
      $time = $form_state
        ->getValue('time_interval_end');
      if (!IntervalHandler::checkTime($time)) {
        $form_state
          ->setErrorByName('time_interval_end', $this
          ->t('Invalid time format. Should be 24 hour format H:i (HH:MM) like 23:30 or 01:00.'));
      }
    }
  }

}

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