[Summary view]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * A scheduled task for global search.
  19   *
  20   * @package    core
  21   * @copyright  2016 Eric Merrill {@link https://www.merrilldigital.com}
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\task;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Runs search index optimization.
  31   *
  32   * @package    core
  33   * @copyright  2016 Eric Merrill {@link https://www.merrilldigital.com}
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class search_optimize_task extends scheduled_task {
  37  
  38      /**
  39       * Get a descriptive name for this task (shown to admins).
  40       *
  41       * @return string
  42       */
  43      public function get_name() {
  44          return get_string('taskglobalsearchoptimize', 'admin');
  45      }
  46  
  47      /**
  48       * Do the job.
  49       * Throw exceptions on errors (the job will be retried).
  50       */
  51      public function execute() {
  52          if (!\core_search\manager::is_indexing_enabled()) {
  53              return;
  54          }
  55  
  56          $globalsearch = \core_search\manager::instance();
  57  
  58          // Optimize index at last.
  59          $globalsearch->optimize_index();
  60      }
  61  }