Search moodle.org's
Developer Documentation

See Release Notes

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

Differences Between: [Versions 310 and 402] [Versions 39 and 402]

Search area for Users for whom I have authority to view profile.

Copyright: 2016 Devang Gaur {@link http://www.devanggaur.com}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 228 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class


Class: user  - X-Ref

Search area for Users for whom I have access to view profile.

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

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

check_access($id)   X-Ref
Checking whether I can access a document

param: int $id user id
return: int

get_doc_url(\core_search\document $doc)   X-Ref
Returns a url to the profile page of user.

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

get_context_url(\core_search\document $doc)   X-Ref
Returns a url to the document context.

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

uses_file_indexing()   X-Ref
Returns true if this area uses file indexing.

return: bool

get_search_fileareas()   X-Ref
Return the context info required to index files for
this search area.

Should be onerridden by each search area.

return: array

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_doc_icon(\core_search\document $doc)   X-Ref
Returns an icon instance for the document.

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

get_category_names()   X-Ref
Returns a list of category names associated with the area.

return: array