Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
|
Search area for received messages. More...
Public Member Functions | |
attach_files ($document) | |
Files related to the current document are attached, to the document object ready for indexing by Global Search. | |
check_access ($id) | |
Whether the user can access the document or not. | |
get_area_id () | |
Returns the area id. | |
get_category_names () | |
Returns a list of category names associated with the area. | |
get_component_name () | |
Returns the moodle component name. | |
get_component_type () | |
Returns the component type. | |
get_config () | |
Returns all the search area configuration. | |
get_config_var_name () | |
Returns the config var name. | |
get_context_url (\core_search\document $doc) | |
Link to the conversation. | |
get_context_url (\core_search\document $doc) | |
Returns a url to the document context. | |
get_contexts_to_reindex () | |
Gets a list of all contexts to reindex when reindexing this search area. | |
get_doc_icon (\core_search\document $doc) | |
Returns an icon instance for the document. | |
get_doc_icon (document $doc) | |
Returns an icon instance for the document. | |
get_doc_url (\core_search\document $doc) | |
Link to the message. | |
get_doc_url (\core_search\document $doc) | |
Returns a url to the document, it might match self\get_context_url(). | |
get_document ($record, $options=array()) | |
Returns the document associated with this message record. | |
get_document_display_title (\core_search\document $doc) | |
Returns the document title to display. | |
get_document_recordset ($modifiedfrom=0, context $context=null) | |
Returns a recordset with the messages for indexing. | |
get_last_indexing_duration () | |
Gets the length of time spent indexing this area (the last time it was indexed). | |
get_recordset_by_timestamp ($modifiedfrom=0) | |
Returns a recordset ordered by modification date ASC. | |
get_search_fileareas () | |
Return the context info required to index files for this search area. | |
get_visible_name ($lazyload=false) | |
Returns the area visible name. | |
is_enabled () | |
Is the search component enabled by the system administrator? | |
set_enabled ($isenabled) | |
supports_get_document_recordset () | |
Checks if get_document_recordset is supported for this search area. | |
uses_file_indexing () | |
Returns true if this area uses file indexing. | |
Static Public Member Functions | |
static | get_levels () |
Returns context levels property. | |
static | get_settingnames () |
Return a list of all required setting names. | |
Public Attributes | |
string | $areaid |
An area id from the componentname and the area name. | |
Protected Member Functions | |
get_course_level_context_restriction_sql (?\context $context, $coursetable, $paramtype=SQL_PARAMS_QM) | |
Helper function that gets SQL useful for restricting a search query given a passed-in context, for data stored at course level. | |
get_current_other_users ($doc) | |
Sorting the current(user1) and other(user2) user in the conversation. | |
get_document_recordset_helper ($modifiedfrom, ?\context $context, $userfield) | |
Helper function to implement get_document_recordset for subclasses. | |
Static Protected Attributes | |
static array | $levels = [CONTEXT_USER] |
The context levels the search area is working on. | |
Search area for received messages.
|
inherited |
Files related to the current document are attached, to the document object ready for indexing by Global Search.
The default implementation retrieves all files for the file areas returned by get_search_fileareas(). If you need to filter files to specific items per file area, you will need to override this method and explicitly provide the items.
document | $document | The current document |
void |
Reimplemented in block_html\search\content, core_search\base_activity, mod_data\search\entry, and mod_forum\search\post.
core_message\search\message_received::check_access | ( | $id | ) |
Whether the user can access the document or not.
int | $id | The message instance id. |
int |
Reimplemented from core_search\base.
|
inherited |
Returns the area id.
string |
|
inherited |
Returns a list of category names associated with the area.
array |
Reimplemented from core_search\base.
|
inherited |
Returns the moodle component name.
It might be the plugin name (whole frankenstyle name) or the core subsystem name.
string |
Reimplemented in core_course\search\course, core_course\search\customfield, core_course\search\section, core_user\search\course_teacher, and core_user\search\user.
|
inherited |
Returns the component type.
It might be a plugintype or 'core' for core subsystems.
string |
|
inherited |
Returns all the search area configuration.
array |
|
inherited |
Returns the config var name.
It depends on whether it is a moodle subsystem or a plugin as plugin-related config should remain in their own scope.
string | Config var path including the plugin (or component) and the varname |
|
inherited |
|
abstractinherited |
Returns a url to the document context.
core_search\document | $doc |
moodle_url |
Reimplemented in core_search\base_activity, and core_search\base_block.
|
inherited |
Gets a list of all contexts to reindex when reindexing this search area.
The list should be returned in an order that is likely to be suitable when reindexing, for example with newer contexts first.
The default implementation simply returns the system context, which will result in reindexing everything in normal date order (oldest first).
Iterator | Iterator of contexts to reindex |
Reimplemented in core_search\base_block, and core_search\base_mod.
|
protectedinherited |
Helper function that gets SQL useful for restricting a search query given a passed-in context, for data stored at course level.
The SQL returned will be zero or more JOIN statements, surrounded by whitespace, which act as restrictions on the query based on the rows in a module table.
You can pass in a null or system context, which will both return an empty string and no params.
Returns an array with two nulls if there can be no results for a course within this context.
If named parameters are used, these will be named gclcrs0, gclcrs1, etc. The table aliases used in SQL also all begin with gclcrs, to avoid conflicts.
context | null | $context | Context to restrict the query |
string | $coursetable | Name of alias for course table e.g. 'c' |
int | $paramtype | Type of SQL parameters to use (default question mark) |
array | Array with SQL and parameters; both null if no need to query |
coding_exception | If called with invalid params |
|
protectedinherited |
Sorting the current(user1) and other(user2) user in the conversation.
core_search\document | $doc |
array() |
|
inherited |
Returns an icon instance for the document.
core_search\document | $doc |
core_search\document_icon |
|
inherited |
Returns an icon instance for the document.
core_search\document | $doc |
core_search\document_icon |
Reimplemented in core_search\base_block, and core_search\base_mod.
|
inherited |
|
abstractinherited |
Returns a url to the document, it might match self\get_context_url().
core_search\document | $doc |
moodle_url |
Reimplemented in core_search\base_activity, and core_search\base_block.
core_message\search\message_received::get_document | ( | $record, | |
$options = array() ) |
Returns the document associated with this message record.
stdClass | $record | |
array | $options |
core_search\document |
Reimplemented from core_message\search\base_message.
|
inherited |
Returns the document title to display.
Allow to customize the document title string to display.
core_search\document | $doc |
string | Document title to display in the search results page |
core_message\search\message_received::get_document_recordset | ( | $modifiedfrom = 0, | |
context | $context = null ) |
Returns a recordset with the messages for indexing.
int | $modifiedfrom | |
context | null | $context | Optional context to restrict scope of returned results |
moodle_recordset|null | Recordset (or null if no results) |
Reimplemented from core_search\base.
|
protectedinherited |
Helper function to implement get_document_recordset for subclasses.
int | $modifiedfrom | Modified from date |
context | null | $context | Context or null |
string | $userfield | Name of user field (from or to) being considered |
moodle_recordset|null | Recordset or null if no results possible |
coding_exception | If context invalid |
|
inherited |
Gets the length of time spent indexing this area (the last time it was indexed).
int|bool | Time in seconds spent indexing this area last time, false if never indexed |
|
staticinherited |
Returns context levels property.
int |
|
inherited |
Returns a recordset ordered by modification date ASC.
Each record can include any data self\get_document might need but it must:
Since Moodle 3.4, subclasses should instead implement get_document_recordset, which has an additional context parameter. This function continues to work for implementations which haven't been updated, or where the context parameter is not required.
int | $modifiedfrom |
moodle_recordset |
|
inherited |
Return the context info required to index files for this search area.
Should be onerridden by each search area.
array |
Reimplemented in core_course\search\course, core_course\search\section, core_search\base_activity, core_user\search\user, mod_assign\search\activity, mod_book\search\chapter, mod_folder\search\activity, mod_forum\search\post, mod_glossary\search\entry, mod_lesson\search\activity, mod_page\search\activity, mod_resource\search\activity, mod_scorm\search\activity, mod_wiki\search\collaborative_page, and mod_workshop\search\activity.
|
staticinherited |
Return a list of all required setting names.
array |
|
inherited |
Returns the area visible name.
bool | $lazyload | Usually false, unless when in admin settings. |
string |
|
inherited |
Is the search component enabled by the system administrator?
bool |
|
inherited |
Checks if get_document_recordset is supported for this search area.
For many uses you can simply call get_document_recordset and see if it returns false, but this function is useful when you don't want to actually call the function right away.
|
inherited |
Returns true if this area uses file indexing.
bool |
Reimplemented in block_html\search\content, core_course\search\course, core_course\search\section, core_user\search\user, mod_assign\search\activity, mod_bigbluebuttonbn\search\activity, mod_bigbluebuttonbn\search\tags, mod_book\search\activity, mod_book\search\chapter, mod_chat\search\activity, mod_choice\search\activity, mod_data\search\activity, mod_data\search\entry, mod_feedback\search\activity, mod_folder\search\activity, mod_forum\search\activity, mod_forum\search\post, mod_glossary\search\activity, mod_glossary\search\entry, mod_h5pactivity\search\activity, mod_imscp\search\activity, mod_label\search\activity, mod_lesson\search\activity, mod_lti\search\activity, mod_page\search\activity, mod_quiz\search\activity, mod_resource\search\activity, mod_scorm\search\activity, mod_survey\search\activity, mod_url\search\activity, mod_wiki\search\activity, mod_wiki\search\collaborative_page, and mod_workshop\search\activity.