Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
- Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
- PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/mod/data/classes/search/ -> entry.php (source)
Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402] [Versions 402 and 403]
Search area for mod_data activity entries.
| Copyright: | 2016 Devang Gaur |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 398 lines (14 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
entry:: (11 methods):
get_document_recordset()
get_document()
check_access()
get_doc_url()
get_context_url()
uses_file_indexing()
attach_files()
get_entry()
get_fields_for_entries()
get_field_class_name()
supports_group_restriction()
Search area for mod_data activity entries.
| get_document_recordset($modifiedfrom = 0, \context $context = null) X-Ref |
| Returns recordset containing required data for indexing database 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 database entry. param: \core_search\document $doc return: \moodle_url |
| get_context_url(\core_search\document $doc) X-Ref |
| Link to the database activity. param: \core_search\document $doc return: \moodle_url |
| uses_file_indexing() X-Ref |
| Returns true if this area uses file indexing. return: bool |
| attach_files($doc) X-Ref |
| Add the database entries attachments. param: \core_search\document $doc return: void |
| get_entry($entryid) X-Ref |
| Get database entry data param: int $entryid return: stdClass |
| get_fields_for_entries($entry) X-Ref |
| get_fields_for_entries param: StdClass $entry return: array |
| get_field_class_name($fieldtype) X-Ref |
| Returns the class name for the given field type and includes it. param: string $fieldtype return: string|null It will return the class name or null if the field type is not available. |
| supports_group_restriction() X-Ref |
| Confirms that data entries support group restrictions. return: bool True |
