Search moodle.org's
Developer Documentation

See Release Notes

  • 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.

Differences Between: [Versions 310 and 400] [Versions 311 and 400] [Versions 39 and 400] [Versions 400 and 401] [Versions 400 and 402] [Versions 400 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: 394 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class


Class: entry  - X-Ref

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.

return: moodle_recordset|null Recordset (or null if no results)
param: int $modifiedfrom timestamp
param: \context|null $context Optional context to restrict scope of returned results

get_document($entry, $options = array()   X-Ref
Returns the documents associated with this glossary entry id.

return: \core_search\document
param: stdClass $entry glossary entry.
param: array    $options

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

return: bool
param: int $id Glossary entry id

get_doc_url(\core_search\document $doc)   X-Ref
Link to database entry.

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

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

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

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.

return: void
param: \core_search\document $doc

get_entry($entryid)   X-Ref
Get database entry data

return: stdClass
param: int $entryid

get_fields_for_entries($entry)   X-Ref
get_fields_for_entries

return: array
param: StdClass $entry

get_field_class_name($fieldtype)   X-Ref
Returns the class name for the given field type and includes it.

return: string|null It will return the class name or null if the field type is not available.
param: string $fieldtype

supports_group_restriction()   X-Ref
Confirms that data entries support group restrictions.

return: bool True