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.

Differences Between: [Versions 310 and 401] [Versions 39 and 401]

   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 block_html blocks
  19   *
  20   * @package block_html
  21   * @copyright 2017 The Open University
  22   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace block_html\search;
  26  
  27  use core_search\moodle_recordset;
  28  
  29  defined('MOODLE_INTERNAL') || die();
  30  
  31  /**
  32   * Search area for block_html blocks
  33   *
  34   * @package block_html
  35   * @copyright 2017 The Open University
  36   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   */
  38  class content extends \core_search\base_block {
  39  
  40      public function get_document($record, $options = array()) {
  41          // Create empty document.
  42          $doc = \core_search\document_factory::instance($record->id,
  43                  $this->componentname, $this->areaname);
  44  
  45          // Get stdclass object with data from DB.
  46          $data = unserialize_object(base64_decode($record->configdata));
  47  
  48          // Get content.
  49          $content = content_to_text($data->text, $data->format);
  50          $doc->set('content', $content);
  51  
  52          if (isset($data->title)) {
  53              // If there is a title, use it as title.
  54              $doc->set('title', content_to_text($data->title, false));
  55          } else {
  56              // If there is no title, use the content text again.
  57              $doc->set('title', shorten_text($content));
  58          }
  59  
  60          // Set standard fields.
  61          $doc->set('contextid', $record->contextid);
  62          $doc->set('type', \core_search\manager::TYPE_TEXT);
  63          $doc->set('courseid', $record->courseid);
  64          $doc->set('modified', $record->timemodified);
  65          $doc->set('owneruserid', \core_search\manager::NO_OWNER_ID);
  66  
  67          // Mark document new if appropriate.
  68          if (isset($options['lastindexedtime']) &&
  69                  ($options['lastindexedtime'] < $record->timecreated)) {
  70              // If the document was created after the last index time, it must be new.
  71              $doc->set_is_new(true);
  72          }
  73  
  74          return $doc;
  75      }
  76  
  77      public function uses_file_indexing() {
  78          return true;
  79      }
  80  
  81      public function attach_files($document) {
  82          $fs = get_file_storage();
  83  
  84          $context = \context::instance_by_id($document->get('contextid'));
  85  
  86          $files = $fs->get_area_files($context->id, 'block_html', 'content',
  87                  false, 'itemid, filepath, filename', false);
  88          foreach ($files as $file) {
  89              $document->add_stored_file($file);
  90          }
  91      }
  92  }