[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   * Adhoc task that clean up data related ro deleted search area.
  19   *
  20   * @package    core
  21   * @copyright  2019 Dmitrii Metelkin <dmitriim@catalyst-au.net>
  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   * Class that cleans up data related to deleted search area.
  31   *
  32   * Custom data accepted:
  33   *  - areaid -> String search area id .
  34   *
  35   * @package     core
  36   * @copyright   2019 Dmitrii Metelkin <dmitriim@catalyst-au.net>
  37   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  38   */
  39  class clean_up_deleted_search_area_task extends adhoc_task {
  40  
  41      /**
  42       * Run the task to clean up deleted search are data.
  43       */
  44      public function execute() {
  45          $areaid = $this->get_custom_data();
  46  
  47          try {
  48              \core_search\manager::clean_up_non_existing_area($areaid);
  49          } catch (\core_search\engine_exception $e) {
  50              mtrace('Search is not configured. Skip deleting index for search area ' . $areaid);
  51          }
  52      }
  53  }