Search moodle.org's
Developer Documentation
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.
/user/classes/search/ -> course_teacher.php (source)
Index teachers in a course
| Author: | Nathan Nguyen <nathannguyen@catalyst-au.net> |
| Copyright: | Catalyst IT |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 218 lines (7 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
course_teacher:: (9 methods):
get_component_name()
get_document_recordset()
get_document()
check_access()
get_context_url()
get_document_display_title()
get_user()
get_category_names()
get_doc_url()
Class: course_teacher - X-Ref
Search for user role assignment in a course| 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_document_recordset($modifiedfrom = 0, \context $context = null) X-Ref |
| Returns recordset containing required data attributes for indexing. param: number $modifiedfrom param: \context|null $context Optional context to restrict scope of returned results return: \moodle_recordset|null Recordset (or null if no results) |
| get_document($record, $options = array() X-Ref |
| Returns document instances for each record in the recordset. param: \stdClass $record param: array $options return: \core_search\document |
| check_access($id) X-Ref |
| Checking whether I can access a document param: int $id user id return: int |
| get_context_url(\core_search\document $doc) X-Ref |
| Returns a url to the document context. param: \core_search\document $doc return: \moodle_url |
| get_document_display_title(\core_search\document $doc) X-Ref |
| Returns the user fullname to display as document title param: \core_search\document $doc return: string User fullname |
| get_user($itemid) X-Ref |
| Get user based on role assignment id param: int $itemid role assignment id return: mixed |
| get_category_names() X-Ref |
| Returns a list of category names associated with the area. return: array |
| get_doc_url(\core_search\document $doc) X-Ref |
| Link to the teacher in the course param: \core_search\document $doc the document return: \moodle_url |
