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.
/message/classes/search/ -> base_message.php (source)
Differences Between: [Versions 310 and 400] [Versions 39 and 400]
Search area base class for messages.
| Copyright: | 2016 Devang Gaur |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 219 lines (8 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
base_message:: (7 methods):
get_document()
get_doc_url()
get_context_url()
get_current_other_users()
get_document_recordset_helper()
get_doc_icon()
get_category_names()
Class: base_message - X-Ref
Search area base class for messages.| get_document($record, $options = array() X-Ref |
| Returns the document associated with this message record. return: \core_search\document param: stdClass $record param: array $options |
| get_doc_url(\core_search\document $doc) X-Ref |
| Link to the message. return: \moodle_url param: \core_search\document $doc |
| get_context_url(\core_search\document $doc) X-Ref |
| Link to the conversation. return: \moodle_url param: \core_search\document $doc |
| get_current_other_users($doc) X-Ref |
| Sorting the current(user1) and other(user2) user in the conversation. return: array() param: \core_search\document $doc |
| get_document_recordset_helper($modifiedfrom, ?\context $context,$userfield) X-Ref |
| Helper function to implement get_document_recordset for subclasses. return: \moodle_recordset|null Recordset or null if no results possible param: int $modifiedfrom Modified from date param: \context|null $context Context or null param: string $userfield Name of user field (from or to) being considered |
| 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 |
