Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.

Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403] [Versions 400 and 403] [Versions 401 and 403]

   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   * Search area for mod_url activities.
  19   *
  20   * @package    mod_url
  21   * @copyright  2015 David Monllao {@link http://www.davidmonllao.com}
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_url\search;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Search area for mod_url activities.
  31   *
  32   * @package    mod_url
  33   * @copyright  2016 Dan Poltawski
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class activity extends \core_search\base_activity {
  37  
  38      /**
  39       * Returns true if this area uses file indexing.
  40       *
  41       * @return bool
  42       */
  43      public function uses_file_indexing() {
  44          return true;
  45      }
  46  
  47      /**
  48       * Returns the document associated with this activity.
  49       *
  50       * Overwrites base_activity to add the provided URL as description.
  51       *
  52       * @param \stdClass $record
  53       * @param array    $options
  54       * @return \core_search\document|false
  55       */
  56      public function get_document($record, $options = array()) {
  57          $doc = parent::get_document($record, $options);
  58          if (!$doc) {
  59              return false;
  60          }
  61  
  62          $doc->set('description1', $record->externalurl);
  63          return $doc;
  64      }
  65  }