class CleanerMySqlOptimizationController in Cleaner 8

Class CleanerMySqlOptimizationController.

@package Drupal\cleaner\Controller

Hierarchy

• class \Drupal\cleaner\Controller\CleanerMySqlOptimizationController implements CleanerControllersInterface

1 string reference to 'CleanerMySqlOptimizationController'

cleaner.services.yml in ./cleaner.services.yml

cleaner.services.yml

1 service uses CleanerMySqlOptimizationController

cleaner_mysql in ./cleaner.services.yml

Drupal\cleaner\Controller\CleanerMySqlOptimizationController

File

src/Controller/CleanerMySqlOptimizationController.php, line 13

Namespace

Drupal\cleaner\Controller

class CleanerMySqlOptimizationController implements CleanerControllersInterface {

  /**
   * Configuration name.
   *
   * @var string
   */
  public static $configName = 'cleaner_optimize_db';

  /**
   * Watchdog log level.
   *
   * @type string
   */
  protected static $logLevel;

  /**
   * Watchdog log message.
   *
   * @type string
   */
  protected static $logMessage;

  /**
   * Database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

  /**
   * Perform the operation.
   */
  public function execute() {
    $this
      ->mysqlOptimize();
  }

  /**
   * MySQL optimizer.
   */
  protected function mysqlOptimize() {
    $opt = \Drupal::config(CLEANER_SETTINGS)
      ->get(self::$configName);
    if ($opt) {

      // Set's the default log level - info.
      static::$logLevel = LogLevel::INFO;

      // Get database connection.
      $this->connection = \Drupal::database();

      // Get's the database driver name.
      $db_type = $this->connection
        ->driver();

      // Make sure the db type hasn't changed.
      if ($db_type == 'mysql') {

        // Gathering tables list.
        $list = $this
          ->buildTablesList();
        if (!empty($list)) {

          // Run optimization timer.
          Timer::start('cleaner_db_optimization');

          // Perform optimization.
          $this
            ->optimizeIt(static::getOptimizationQuery($opt, $list));

          // Write a log about successful optimization into the watchdog.
          // Convert tables list into a comma-separated list.
          $list = implode(', ', $list);

          // Get the timers's results.
          $time = static::getTimerResult();

          // Create a log message.
          static::$logMessage = "Optimized tables: {$list}. This required {$time} seconds.";
        }
        else {

          // Write a log about thing that optimization process is
          // no tables which can to be optimized.
          static::$logMessage = 'There is no tables which can to be optimized.';
        }
      }
      else {

        // Write a log(error) about thing that optimization process
        // isn't allowed for non-MySQL databases into the watchdog.
        // Change log level to an error.
        static::$logLevel = LogLevel::ERROR;
        static::$logMessage = "Database type ({$db_type}) not allowed to be optimized.";
      }

      // Write some logs.
      \Drupal::service('cleaner_logger')
        ->log(static::$logLevel, static::$logMessage);
    }
  }

  /**
   * Extract and format the timer results.
   *
   * @return string
   *   Formatted timer results.
   */
  private static function getTimerResult() {

    // Get raw timer's data in milliseconds.
    $raw = Timer::read('cleaner_db_optimization');

    // Convert it to seconds.
    $raw /= 1000;

    // Convert it to the correct number format.
    return number_format($raw, 3);
  }

  /**
   * Perform the optimization query.
   *
   * @param string $query
   *   Query string.
   */
  protected function optimizeIt($query) {
    $this->connection
      ->query((string) $query)
      ->execute();
  }

  /**
   * Build the optimization query string.
   *
   * @param int $opt
   *   Operation flag.
   * @param array $list
   *   Tables list array.
   *
   * @return string
   *   Optimization query string.
   */
  protected static function getOptimizationQuery($opt, $list) {
    $query = 'OPTIMIZE ' . ($opt == 2 ? 'LOCAL ' : '');
    $query .= 'TABLE {' . implode('}, {', $list) . '}';
    return $query;
  }

  /**
   * Build the tables list.
   *
   * @return array Tables list array.
   *   Tables list array.
   */
  protected function buildTablesList() {
    $list = [];
    $tables = (array) $this->connection
      ->query("SHOW TABLE STATUS");
    if (!empty($tables)) {
      foreach ($tables as $table) {
        if (isset($table->Data_free) && !empty($table->Data_free)) {
          $list[] = (string) $table->Name;
        }
      }
    }
    return $list;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CleanerMySqlOptimizationController::$configName	public static	property	Configuration name.
CleanerMySqlOptimizationController::$connection	protected	property	Database connection.
CleanerMySqlOptimizationController::$logLevel	protected static	property	Watchdog log level.
CleanerMySqlOptimizationController::$logMessage	protected static	property	Watchdog log message.
CleanerMySqlOptimizationController::buildTablesList	protected	function	Build the tables list.
CleanerMySqlOptimizationController::execute	public	function	Perform the operation. Overrides CleanerControllersInterface::execute
CleanerMySqlOptimizationController::getOptimizationQuery	protected static	function	Build the optimization query string.
CleanerMySqlOptimizationController::getTimerResult	private static	function	Extract and format the timer results.
CleanerMySqlOptimizationController::mysqlOptimize	protected	function	MySQL optimizer.
CleanerMySqlOptimizationController::optimizeIt	protected	function	Perform the optimization query.