Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
   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   * Data indexed event.
  19   *
  20   * @package    core
  21   * @copyright  2015 David Monllao - http://www.davidmonllao.com
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Event when new data has been indexed.
  31   *
  32   * @package    core
  33   * @since      Moodle 3.1
  34   * @copyright  2015 David Monllao {@link http://www.davidmonllao.com}
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class search_indexed extends base {
  38  
  39      /**
  40       * Initialise required event data properties.
  41       */
  42      protected function init() {
  43          $this->data['crud'] = 'c';
  44          $this->data['edulevel'] = self::LEVEL_OTHER;
  45      }
  46  
  47      /**
  48       * Returns localised event name.
  49       *
  50       * @return string
  51       */
  52      public static function get_name() {
  53          return get_string('eventsearchindexed');
  54      }
  55  
  56      /**
  57       * Returns non-localised event description.
  58       *
  59       * @return string
  60       */
  61      public function get_description() {
  62          if (!empty($this->userid)) {
  63              return "The user with id '{$this->userid}' updated the search engine data";
  64          } else {
  65              return 'The search engine data has been updated';
  66          }
  67      }
  68  
  69      /**
  70       * Returns relevant URL.
  71       *
  72       * @return \moodle_url
  73       */
  74      public function get_url() {
  75          return new \moodle_url('/admin/searchareas.php');
  76      }
  77  }