class AdminHookHandler in DB Maintenance 7.2

AdminHookHandler class.

Hierarchy

• class \Drupal\db_maintenance\Module\Hook\AdminHookHandler

1 file declares its use of AdminHookHandler

db_maintenance.admin.inc in ./db_maintenance.admin.inc

Module db_maintenance admin section.

File

src/Module/Hook/AdminHookHandler.php, line 17

AdminHookHandler class.

Namespace

Drupal\db_maintenance\Module\Hook

class AdminHookHandler {

  /**
   * Administration settings.
   *
   * Options: log each optimization, multi-select list of tables to optimize.
   *
   * @return array
   *   An array containing form items to place on the module settings page.
   */
  public static function hookAdminSettings() {
    global $databases;
    drupal_add_css(drupal_get_path('module', 'db_maintenance') . '/db_maintenance.css');
    $form = array();
    $form['db_maintenance_log'] = array(
      '#type' => 'checkbox',
      '#title' => 'Log OPTIMIZE queries',
      '#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.'),
    );
    $form['schedule'] = array(
      '#type' => 'fieldset',
      '#title' => t('Schedule'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
    );
    $options = array(
      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'),
    );
    $form['schedule']['db_maintenance_cron_frequency'] = array(
      '#type' => 'select',
      '#title' => t('Optimize tables'),
      '#options' => $options,
      '#default_value' => ConfigHandler::getCronFrequency(),
      '#description' => t('Select how often database tables should be optimized.') . ' ' . l(t('Optimize now.'), 'db_maintenance/optimize'),
    );

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

    // Visibility.
    $states1 = array(
      'visible' => array(
        ':input[name="db_maintenance_use_time_interval"]' => array(
          'checked' => TRUE,
        ),
      ),
    );
    $form['schedule']['db_maintenance_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['schedule']['db_maintenance_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['schedule']['db_maintenance_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,
    );
    $form['tables'] = array(
      '#type' => 'fieldset',
      '#title' => t('Tables'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
    );

    // Visibility.
    $states = array(
      'visible' => array(
        ':input[name="db_maintenance_all_tables"]' => array(
          'checked' => FALSE,
        ),
      ),
    );
    $form['tables']['db_maintenance_all_tables'] = array(
      '#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 ($databases as $db => $connection) {
      $options = DbHandler::listTables($db);
      $form['tables']['db_maintenance_table_list_' . $connection['default']['database']] = array(
        '#type' => 'select',
        '#title' => t('Tables in the !db database', array(
          '!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' => array(
          'size' => 17,
        ),
        '#states' => $states,
      );
    }
    return system_settings_form($form);
  }

  /**
   * Validation for the administrative settings form.
   *
   * @param object $form
   *   An associative array containing the structure of the form.
   * @param object $form_state
   *   A keyed array containing the current state of the form.
   */
  public static function hookAdminSettingsValidate($form, &$form_state) {

    // Check time interval.
    if ($form_state['values']['db_maintenance_use_time_interval'] == 1) {

      // Check start value.
      $time = $form_state['values']['db_maintenance_time_interval_start'];
      if (!IntervalHandler::checkTime($time)) {
        form_set_error('db_maintenance_time_interval_start', 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['values']['db_maintenance_time_interval_end'];
      if (!IntervalHandler::checkTime($time)) {
        form_set_error('db_maintenance_time_interval_end', t('Invalid time format. Should be 24 hour format H:i (HH:MM) like 23:30 or 01:00.'));
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AdminHookHandler::hookAdminSettings	public static	function	Administration settings.
AdminHookHandler::hookAdminSettingsValidate	public static	function	Validation for the administrative settings form.