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]

Search area for Moodle courses.

Copyright: 2016 Skylar Kelty <S.Kelty@kent.ac.uk>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 198 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class


Class: course  - X-Ref

Search area for Moodle courses.

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

param: int $modifiedfrom timestamp
param: \context|null $context Restriction context
return: \moodle_recordset|null Recordset or null if no change possible

get_document($record, $options = array()   X-Ref
Returns the document associated with this course.

param: \stdClass $record
param: array    $options
return: \core_search\document

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

param: int $id The course instance id.
return: int

get_doc_url(\core_search\document $doc)   X-Ref
Link to the course.

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

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

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

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.

Should be overridden by each search area.

return: array

get_component_name()   X-Ref
Returns the moodle component name.

It might be the plugin name (whole frankenstyle name) or the core subsystem name.

return: string

get_doc_icon(\core_search\document $doc)   X-Ref
Returns an icon instance for the document.

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

get_category_names()   X-Ref
Returns a list of category names associated with the area.

return: array