Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
- Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
- PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/course/classes/search/ -> section.php (source)
Search area for course sections (title and summary).
| Copyright: | 2018 The Open University |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 217 lines (7 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
section:: (10 methods):
get_document_recordset()
get_document()
check_access()
get_doc_url()
get_context_url()
uses_file_indexing()
get_search_fileareas()
get_component_name()
get_doc_icon()
get_category_names()
Search area for course sections (title and summary).
Note this does not include the activities within the section, as these have their own search
areas.
Note this does not include the activities within the section, as these have their own search
areas.
| get_document_recordset($modifiedfrom = 0, \context $context = null) X-Ref |
| Returns recordset containing required data for indexing course sections. return: \moodle_recordset|null Recordset or null if no change possible param: int $modifiedfrom timestamp param: \context|null $context Restriction context |
| get_document($record, $options = array() X-Ref |
| Returns the document associated with this section. return: \core_search\document param: \stdClass $record param: array $options |
| check_access($id) X-Ref |
| Whether the user can access the section or not. return: int One of the \core_search\manager:ACCESS_xx constants param: int $id The course section id. |
| get_doc_url(\core_search\document $doc) X-Ref |
| Gets a link to the section. return: \moodle_url param: \core_search\document $doc |
| get_context_url(\core_search\document $doc) X-Ref |
| Gets a link to the section. return: \moodle_url param: \core_search\document $doc |
| uses_file_indexing() X-Ref |
| Returns true to include summary files in the index. return: bool True |
| get_search_fileareas() X-Ref |
| Return the file area that is used for summary files. return: array File area name |
| get_component_name() X-Ref |
| Returns the moodle component name, as used in the files table. return: string Component name |
| get_doc_icon(\core_search\document $doc) X-Ref |
| Returns an icon instance for the document. return: \core_search\document_icon param: \core_search\document $doc |
| get_category_names() X-Ref |
| Returns a list of category names associated with the area. return: array |
