Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
search_solr\document Class Reference

Respresents a document to index. More...

Inheritance diagram for search_solr\document:
core_search\document renderable templatable

Public Member Functions

 add_stored_file ($file)
 Add a stored file to the document.
 
 export_doc (\renderer_base $output)
 Returns the current docuement information.
 
 export_file_for_engine ($file)
 Export the data for the given file in relation to this document.
 
 export_for_engine ()
 Returns the document ready to submit to the search engine.
 
 export_for_template (\renderer_base $output)
 Export the document data to be used as a template context.
 
 export_for_template (renderer_base $output)
 Function to export the renderer data in a format that is suitable for a mustache template.
 
 get ($field)
 Getter.
 
 get_context_url ()
 Gets the url to the context.
 
 get_doc_icon ()
 Gets document icon instance.
 
 get_doc_url ()
 Gets the url to the doc.
 
 get_files ()
 Returns the array of attached files.
 
 get_is_new ()
 Returns if the document is new.
 
 is_set ($field)
 Checks if a field is set.
 
 set ($fieldname, $value)
 Setter.
 
 set_context_url (\moodle_url $url)
 
 set_data_from_engine ($docdata)
 Fills the document with data coming from the search engine.
 
 set_doc_icon (document_icon $docicon)
 Sets document icon instance.
 
 set_doc_url (\moodle_url $url)
 Sets the document url.
 
 set_extra ($fieldname, $value)
 Sets data to this->extradata.
 
 set_is_new ($new)
 Set if this is a new document.
 

Static Public Member Functions

static format_string_for_engine ($string)
 Formats the timestamp according to the search engine needs.
 
static format_text_for_engine ($text)
 Formats a text value for the search engine.
 
static format_time_for_engine ($timestamp)
 Formats the timestamp according to the search engine needs.
 
static get_default_fields_definition ()
 Returns all default fields definitions.
 
static import_time_from_engine ($time)
 Returns a timestamp from the value stored in the search engine.
 

Public Attributes

const INDEXED_FILE_ERROR = -1
 Indicates the file contents were not indexed due to an error.
 
const INDEXED_FILE_FALSE = 0
 Indicates the file contents were not indexed due filtering/settings.
 
const INDEXED_FILE_TRUE = 1
 Indicates the file contents are indexed with the record.
 
int const SCHEMA_VERSION = 2017091700
 Change list (for engine implementers): 2017091700 - add optional field groupid.
 

Protected Member Functions

 apply_defaults ()
 Apply any defaults to unset fields before export.
 
 format_text ($text)
 Formats a text string coming from the search engine.
 
 get_text_format ()
 Overwritten to use HTML (highlighting).
 

Protected Attributes

int null $contentfilearea = null
 The content field filearea.
 
int null $contentitemid = null
 The content field itemid.
 
moodle_url $contexturl = null
 Link to the document context.
 
array $data = array()
 $data The document data.
 
core_search document_icon $docicon = null
 Document icon instance.
 
moodle_url $docurl = null
 Link to the document.
 
array $extradata = array()
 Extra data needed to render the document.
 
stored_file[] $files = array()
 An array of stored files to attach to the document.
 
bool $isnew = false
 Should be set to true if document hasn't been indexed before.
 

Static Protected Attributes

static array $enginefields
 Any fields that are engine specifc.
 
static array $optionalfields
 All optional fields docs can contain.
 
static array $requiredfields
 All required fields any doc should contain.
 

Detailed Description

Respresents a document to index.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ add_stored_file()

core_search\document::add_stored_file ( $file)
inherited

Add a stored file to the document.

Parameters
stored_file | int$fileThe file to add, or file id.
Return values
void

◆ apply_defaults()

search_solr\document::apply_defaults ( )
protected

Apply any defaults to unset fields before export.

Called after document building, but before export.

Sub-classes of this should make sure to call parent\apply_defaults().

Reimplemented from core_search\document.

◆ export_doc()

core_search\document::export_doc ( \renderer_base $output)
inherited

Returns the current docuement information.

Adding more info than the required one as themers and ws clients might be interested in showing more stuff.

Although content is a required field when setting up the document, it accepts '' (empty) values as they may be the result of striping out HTML.

SECURITY NOTE: It is the responsibility of the document to properly escape any text to be displayed. The renderer will output the content without any further cleaning.

Parameters
renderer_base$outputThe renderer.
Return values
array

◆ export_file_for_engine()

search_solr\document::export_file_for_engine ( $file)

Export the data for the given file in relation to this document.

Parameters
stored_file$fileThe stored file we are talking about.
Return values
array

◆ export_for_engine()

core_search\document::export_for_engine ( )
inherited

Returns the document ready to submit to the search engine.

Exceptions
coding_exception
Return values
array

◆ export_for_template() [1/2]

core_search\document::export_for_template ( \renderer_base $output)
inherited

Export the document data to be used as a template context.

Just delegates all the processing to export_doc_info, also used by external functions. Adding more info than the required one as people might be interested in extending the template.

Parameters
renderer_base$outputThe renderer.
Return values
array

◆ export_for_template() [2/2]

templatable::export_for_template ( renderer_base $output)
inherited

Function to export the renderer data in a format that is suitable for a mustache template.

This means:

  1. No complex types - only stdClass, array, int, string, float, bool
  2. Any additional info that is required for the template is pre-calculated (e.g. capability checks).
Parameters
renderer_base$outputUsed to do a final render of any components that need to be rendered for export.
Return values
stdClass|array

Implemented in action_menu, assign_attempt_history_chooser, block_lp\output\competencies_to_review_page, block_lp\output\plans_to_review_page, block_lp\output\summary, block_myoverview\output\main, block_myprofile\output\myprofile, block_recentlyaccessedcourses\output\main, block_recentlyaccesseditems\output\main, block_search_forums\output\search_form, block_starredcourses\output\main, block_timeline\output\main, booktool_print\output\print_book_chapter_page, booktool_print\output\print_book_page, component_action, context_header, core\navigation\output\more_menu, core\output\activity_header, core\output\checkbox_toggleall, core\output\choicelist, core\output\chooser, core\output\chooser_item, core\output\chooser_section, core\output\comboboxsearch, core\output\dynamic_tabs, core\output\select_menu, core_admin\output\theme_selector, core_auth\output\digital_minor_page, core_auth\output\login, core_auth\output\verify_age_location_page, core_badges\output\manage_badge_action_bar, core_badges\output\recipients_action_bar, core_badges\output\standard_action_bar, core_contentbank\output\bankcontent, core_contentbank\output\viewcontent, core_course\output\activity_completion, core_course\output\activity_dates, core_course\output\activity_information, core_course\output\completion_action_bar, core_courseformat\output\activitybadge, core_courseformat\output\local\content\cm, core_courseformat\output\local\content\section, core_group\output\group_details, core_group\output\index_page, core_h5p\output\libraries, core_privacy\output\exported_html_page, core_privacy\output\exported_navigation_page, core_question\output\qbank_action_menu, core_question\output\question_bank_filter_ui, core_question\output\question_version_info, core_question\output\question_version_selection, core_reportbuilder\output\custom_report, core_reportbuilder\output\dynamictabs\access, core_reportbuilder\output\dynamictabs\audience, core_reportbuilder\output\dynamictabs\editor, core_reportbuilder\output\dynamictabs\schedules, core_reportbuilder\output\system_report, core_tag\output\tag, core_tag\output\tagcloud, core_tag\output\tagfeed, core_tag\output\tagindex, core_tag\output\taglist, core_user\output\participants_filter, core_user\output\status_field, custom_menu_item, enrol_lti\output\registration, format_topics\output\courseformat\content, forumreport_summary\output\filters, gradereport_singleview\output\action_bar, help_icon, initials_bar, login_signup_form, mod_assign\output\grading_app, mod_assign\output\timelimit_panel, mod_bigbluebuttonbn\output\import_view, mod_bigbluebuttonbn\output\instance_updated_message, mod_bigbluebuttonbn\output\recording_row_actionbar, mod_bigbluebuttonbn\output\recording_row_playback, mod_bigbluebuttonbn\output\recording_row_preview, mod_bigbluebuttonbn\output\recordings_session, mod_bigbluebuttonbn\output\view_page, mod_data\output\presets, mod_data\output\view_footer, mod_feedback\output\base_action_bar, mod_feedback\output\summary, mod_forum\output\big_search_form, mod_forum\output\forum_actionbar, mod_forum\output\quick_search_form, mod_forum\output\subscription_actionbar, mod_glossary\output\standard_action_bar, mod_h5pactivity\output\attempt, mod_h5pactivity\output\reportattempts, mod_h5pactivity\output\reportlink, mod_h5pactivity\output\reportresults, mod_h5pactivity\output\result, mod_h5pactivity\output\result\longfillin, mod_h5pactivity\output\result\other, mod_lti\output\course_tools_page_header, mod_lti\output\external_registration_return_page, mod_lti\output\registration_upgrade_choice_page, mod_lti\output\repost_crosssite_page, mod_lti\output\tool_configure_page, mod_quiz\output\attempt_summary_information, mod_quiz\output\edit_grading_page, mod_quiz\output\edit_nav_actions, mod_quiz\output\list_of_attempts, mod_quiz\output\overrides_actions, mod_scorm\output\actionbar, mod_scorm\output\userreportsactionbar, mod_survey\output\actionbar, mod_workshop\output\actionbar, MoodleQuickForm_advcheckbox, MoodleQuickForm_autocomplete, MoodleQuickForm_button, MoodleQuickForm_checkbox, MoodleQuickForm_choicedropdown, MoodleQuickForm_date_selector, MoodleQuickForm_date_time_selector, MoodleQuickForm_editor, MoodleQuickForm_filemanager, MoodleQuickForm_filepicker, MoodleQuickForm_grading, MoodleQuickForm_group, MoodleQuickForm_passwordunmask, MoodleQuickForm_recaptcha, MoodleQuickForm_select, MoodleQuickForm_selectgroups, MoodleQuickForm_selectwithlink, MoodleQuickForm_static, MoodleQuickForm_submit, MoodleQuickForm_tags, MoodleQuickForm_textarea, MoodleQuickForm_url, MoodleQuickForm_warning, MoodleQuickForm_wikieditor, paging_bar, pix_icon, pix_icon_font, progress_bar, qbank_columnsortorder\output\add_column, qbank_columnsortorder\output\reset_columns, qbank_editquestion\output\add_new_question, qbank_viewquestiontext\output\question_text_format, qtype_ordering\output\feedback, report_competency\output\report, report_competency\output\user_course_navigation, single_select, tabobject, tabtree, tool_admin_presets\output\export_import, tool_admin_presets\output\presets_list, tool_componentlibrary\local\examples\dynamictabs\tab1, tool_componentlibrary\local\examples\dynamictabs\tab2, tool_customlang\output\translator, tool_dataprivacy\output\categories, tool_dataprivacy\output\data_deletion_page, tool_dataprivacy\output\data_registry_compliance_page, tool_dataprivacy\output\data_registry_page, tool_dataprivacy\output\data_requests_page, tool_dataprivacy\output\defaults_page, tool_dataprivacy\output\my_data_requests_page, tool_dataprivacy\output\purposes, tool_dataprivacy\output\request_filter, tool_dataprivacy\output\summary_page, tool_generator\output\parsingresult, tool_langimport\output\langimport_page, tool_lp\output\competency_plan_navigation, tool_lp\output\competency_summary, tool_lp\output\course_competencies_page, tool_lp\output\manage_competencies_page, tool_lp\output\manage_competency_frameworks_page, tool_lp\output\manage_templates_page, tool_lp\output\module_navigation, tool_lp\output\plans_page, tool_lp\output\related_competencies, tool_lp\output\template_competencies_page, tool_lp\output\user_competency_course_navigation, tool_lp\output\user_competency_summary, tool_lp\output\user_competency_summary_in_course, tool_lp\output\user_evidence_list_page, tool_policy\output\acceptances, tool_policy\output\guestconsent, tool_policy\output\page_agreedocs, tool_policy\output\page_managedocs_list, tool_policy\output\page_nopermission, tool_policy\output\page_viewalldoc, tool_policy\output\page_viewdoc, tool_templatelibrary\output\list_templates_page, and url_select.

◆ format_string_for_engine()

static search_solr\document::format_string_for_engine ( $string)
static

Formats the timestamp according to the search engine needs.

Parameters
int$timestamp
Return values
string

Reimplemented from core_search\document.

◆ format_text()

search_solr\document::format_text ( $text)
protected

Formats a text string coming from the search engine.

Even if this is called through an external function it is fine to return HTML as HTML is considered solr's search engine text format. An external function can ask for raw text, but this just means that it will not pass through format_text, no that we can not add HTML.

Parameters
string$textText to format
Return values
stringHTML text to be renderer

Reimplemented from core_search\document.

◆ format_text_for_engine()

static core_search\document::format_text_for_engine ( $text)
staticinherited

Formats a text value for the search engine.

Search engines may overwrite this method to apply restrictions, like limiting the size. The default behaviour is just returning the string.

Parameters
string$text
Return values
string

◆ format_time_for_engine()

static search_solr\document::format_time_for_engine ( $timestamp)
static

Formats the timestamp according to the search engine needs.

Parameters
int$timestamp
Return values
string

Reimplemented from core_search\document.

◆ get()

core_search\document::get ( $field)
inherited

Getter.

Use self\is_set if you are not sure if this field is set or not as otherwise it will trigger a coding_exception

Exceptions
coding_exception
Parameters
string$field
Return values
string|int

◆ get_context_url()

core_search\document::get_context_url ( )
inherited

Gets the url to the context.

Return values
moodle_url

◆ get_default_fields_definition()

static core_search\document::get_default_fields_definition ( )
staticinherited

Returns all default fields definitions.

Return values
array

◆ get_doc_icon()

core_search\document::get_doc_icon ( )
inherited

Gets document icon instance.

Return values
core_search\document_icon

◆ get_doc_url()

core_search\document::get_doc_url ( )
inherited

Gets the url to the doc.

Return values
moodle_url

◆ get_files()

core_search\document::get_files ( )
inherited

Returns the array of attached files.

Return values
stored_file[]

◆ get_is_new()

core_search\document::get_is_new ( )
inherited

Returns if the document is new.

False if unknown.

Return values
bool

◆ get_text_format()

search_solr\document::get_text_format ( )
protected

Overwritten to use HTML (highlighting).

Return values
int

Reimplemented from core_search\document.

◆ import_time_from_engine()

static search_solr\document::import_time_from_engine ( $time)
static

Returns a timestamp from the value stored in the search engine.

Parameters
string$time
Return values
int

Reimplemented from core_search\document.

◆ is_set()

core_search\document::is_set ( $field)
inherited

Checks if a field is set.

Parameters
string$field
Return values
bool

◆ set()

core_search\document::set ( $fieldname,
$value )
inherited

Setter.

Basic checkings to prevent common issues.

If the field is a string tags will be stripped, if it is an integer or a date it will be casted to a PHP integer. tdate fields values are expected to be timestamps.

Exceptions
coding_exception
Parameters
string$fieldnameThe field name
string | int$valueThe value to store
Return values
string|intThe stored value

◆ set_data_from_engine()

core_search\document::set_data_from_engine ( $docdata)
inherited

Fills the document with data coming from the search engine.

Exceptions
core_search\engine_exception
Parameters
array$docdata
Return values
void

◆ set_doc_icon()

core_search\document::set_doc_icon ( document_icon $docicon)
inherited

Sets document icon instance.

Parameters
core_search\document_icon$docicon

◆ set_doc_url()

core_search\document::set_doc_url ( \moodle_url $url)
inherited

Sets the document url.

Parameters
moodle_url$url
Return values
void

◆ set_extra()

core_search\document::set_extra ( $fieldname,
$value )
inherited

Sets data to this->extradata.

This data can be retrieved using core_search\document->get($fieldname).

Parameters
string$fieldname
string$value
Return values
void

◆ set_is_new()

core_search\document::set_is_new ( $new)
inherited

Set if this is a new document.

False if unknown.

Parameters
bool$new

Member Data Documentation

◆ $enginefields

array search_solr\document::$enginefields
staticprotected
Initial value:
= array(
'solr_filegroupingid' => array(
'type' => 'string',
'stored' => true,
'indexed' => true
),
'solr_fileid' => array(
'type' => 'string',
'stored' => true,
'indexed' => true
),
'solr_filecontenthash' => array(
'type' => 'string',
'stored' => true,
'indexed' => true
),
'solr_fileindexstatus' => array(
'type' => 'int',
'stored' => true,
'indexed' => true
),
'solr_filecontent' => array(
'type' => 'text',
'stored' => false,
'indexed' => true,
'mainquery' => true
)
)

Any fields that are engine specifc.

These are fields that are solely used by a seach engine plugin for internal purposes.

◆ $isnew

bool core_search\document::$isnew = false
protectedinherited

Should be set to true if document hasn't been indexed before.

False if unknown.

◆ $optionalfields

array core_search\document::$optionalfields
staticprotectedinherited
Initial value:
= array(
'userid' => array(
'type' => 'int',
'stored' => true,
'indexed' => true
),
'groupid' => array(
'type' => 'int',
'stored' => true,
'indexed' => true
),
'description1' => array(
'type' => 'text',
'stored' => true,
'indexed' => true,
'mainquery' => true
),
'description2' => array(
'type' => 'text',
'stored' => true,
'indexed' => true,
'mainquery' => true
)
)

All optional fields docs can contain.

Although it matches solr fields format, this is just to define the field types. Search engine plugins are responsible of setting their appropriate field types and map these naming to whatever format they need.

◆ $requiredfields

array core_search\document::$requiredfields
staticprotectedinherited

All required fields any doc should contain.

We have to choose a format to specify field types, using solr format as we have to choose one and solr is the default search engine.

Search engine plugins are responsible of setting their appropriate field types and map these naming to whatever format they need.

◆ SCHEMA_VERSION

int const core_search\document::SCHEMA_VERSION = 2017091700
inherited

Change list (for engine implementers): 2017091700 - add optional field groupid.

Schema version number (update if any change)


The documentation for this class was generated from the following file: