Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.

Glossary entries search.

Copyright: 2015 David Monllao {@link http://www.davidmonllao.com}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 225 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class


Class: entry  - X-Ref

Glossary entries search.

get_document_recordset($modifiedfrom = 0, \context $context = null)   X-Ref
Returns recordset containing required data for indexing glossary entries.

param: int $modifiedfrom timestamp
param: \context|null $context Optional context to restrict scope of returned results
return: moodle_recordset|null Recordset (or null if no results)

get_document($entry, $options = array()   X-Ref
Returns the documents associated with this glossary entry id.

param: stdClass $entry glossary entry.
param: array    $options
return: \core_search\document

check_access($id)   X-Ref
Whether the user can access the document or not.

param: int $id Glossary entry id
return: bool

get_doc_url(\core_search\document $doc)   X-Ref
Link to glossary entry.

param: \core_search\document $doc
return: \moodle_url

get_context_url(\core_search\document $doc)   X-Ref
Link to the glossary.

param: \core_search\document $doc
return: \moodle_url

get_entry($entryid)   X-Ref
Returns the specified glossary entry checking the internal cache.

Store minimal information as this might grow.

param: int $entryid
return: stdClass

uses_file_indexing()   X-Ref
Returns true if this area uses file indexing.

return: bool

get_search_fileareas()   X-Ref
Return the context info required to index files for
this search area.

return: array