Search area base class for blocks. More...

Inheritance diagram for core_search\base_block:

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)
	Checks access for a document in this search area.

	get_area_id ()
	Returns the area id.

	get_block_name ()
	Gets the block name only.

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

	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 related with the provided record.

	get_document_display_title (\core_search\document $doc)
	Returns the document title to display.

	get_document_recordset ($modifiedfrom=0, context $context=null)
	Gets recordset of all blocks of this type modified since given time within the given context.

	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	clear_static ()
	Clears static cache.

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.

string const	CACHE_INSTANCES = 'base_block_instances'
	Cache name used for block instances.

Protected Member Functions
	get_block_instance ($id, $strictness=MUST_EXIST)
	Gets a block instance with given id.

	get_context_restriction_sql (\context $context=null, $blocktable='bi', $paramtype=SQL_PARAMS_QM)
	Helper function that gets SQL useful for restricting a search query given a passed-in context.

	get_contexts_to_reindex_extra_sql ()
	This can be used in subclasses to change ordering within the get_contexts_to_reindex function.

	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_indexing_restrictions ()
	Returns restrictions on which block_instances rows to return.

Static Protected Member Functions
static	is_supported_page_type_at_course_context ($pagetype)
	Checks if a page type is supported for blocks when at course (or also site) context.

Protected Attributes
string	$areaname = null
	The area name as defined in the class name.

string	$componentname = null
	The component frankenstyle name.

string	$componenttype = null
	The component type (core or the plugin type).

Static Protected Attributes
static array	$levels = [CONTEXT_BLOCK]
	The context levels the search area is working on.

Detailed Description

Search area base class for blocks.

Note: Only blocks within courses are supported.

Copyright: 2017 The Open University

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

Member Function Documentation

◆ attach_files()

core_search\base::attach_files ( $document )

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.

Parameters

document $document The current document

Return values

void

Reimplemented in block_html\search\content, core_search\base_activity, mod_data\search\entry, and mod_forum\search\post.

◆ check_access()

core_search\base_block::check_access ( $id )

Checks access for a document in this search area.

If you override this function for a block, you should call this base class version first as it will check that the block is still visible to users in a supported location.

Parameters

int $id Document id

Return values

int	manager:ACCESS_xx constant

Reimplemented from core_search\base.

◆ clear_static()

static core_search\base_block::clear_static ( )

static

Clears static cache.

This function can be removed (with calls to it in the test script replaced with cache_helper\purge_all) if MDL-59427 is fixed.

◆ get_area_id()

core_search\base::get_area_id ( )

inherited

Returns the area id.

Return values

string

◆ get_block_instance()

core_search\base_block::get_block_instance	(		$id,
			$strictness = MUST_EXIST )

protected

Gets a block instance with given id.

Returns the fields id, pagetypepattern, subpagepattern from block_instances and also the cmid (if parent context is an activity module).

Parameters

int	$id	ID of block instance
int	$strictness	MUST_EXIST or IGNORE_MISSING

Return values

false|mixed Block instance data (may be false if strictness is IGNORE_MISSING)

◆ get_block_name()

core_search\base_block::get_block_name ( )

Gets the block name only.

Return values

string Block name e.g. 'html'

◆ get_category_names()

core_search\base_block::get_category_names ( )

Returns a list of category names associated with the area.

Return values

array

Reimplemented from core_search\base.

◆ get_component_name()

core_search\base::get_component_name ( )

inherited

Returns the moodle component name.

It might be the plugin name (whole frankenstyle name) or the core subsystem name.

Return values

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.

◆ get_component_type()

core_search\base::get_component_type ( )

inherited

Returns the component type.

It might be a plugintype or 'core' for core subsystems.

Return values

string

◆ get_config()

core_search\base::get_config ( )

inherited

Returns all the search area configuration.

Return values

array

◆ get_config_var_name()

core_search\base::get_config_var_name ( )

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.

Return values

string Config var path including the plugin (or component) and the varname

◆ get_context_restriction_sql()

core_search\base_block::get_context_restriction_sql	(	\context	$context = null,
			$blocktable = 'bi',
			$paramtype = SQL_PARAMS_QM )

protected

Helper function that gets SQL useful for restricting a search query given a passed-in context.

The SQL returned will be one or more JOIN statements, surrounded by whitespace, which act as restrictions on the query based on the rows in the block_instances table.

We assume the block instances have already been restricted by blockname.

Returns null if there can be no results for this block within this context.

If named parameters are used, these will be named gcrs0, gcrs1, etc. The table aliases used in SQL also all begin with gcrs, to avoid conflicts.

Parameters

context \| null	$context	Context to restrict the query
string	$blocktable	Alias of block_instances table
int	$paramtype	Type of SQL parameters to use (default question mark)

Return values

array Array with SQL and parameters

Exceptions

coding_exception If called with invalid params

◆ get_context_url()

core_search\base_block::get_context_url ( \core_search\document $doc )

Returns a url to the document context.

Parameters

core_search\document $doc

Return values

moodle_url

Reimplemented from core_search\base.

◆ get_contexts_to_reindex()

core_search\base_block::get_contexts_to_reindex ( )

Gets a list of all contexts to reindex when reindexing this search area.

For blocks, the default is to return all contexts for blocks of that type, that are on a course page, in order of time added (most recent first).

Return values

Iterator Iterator of contexts to reindex

Exceptions

moodle_exception If any DB error

Reimplemented from core_search\base.

◆ get_contexts_to_reindex_extra_sql()

core_search\base_block::get_contexts_to_reindex_extra_sql ( )

protected

This can be used in subclasses to change ordering within the get_contexts_to_reindex function.

It returns 2 values:

Extra SQL joins (tables block_instances 'bi' and context 'x' already exist).
An ORDER BY value which must use aggregate functions, by default 'MAX(bi.timemodified) DESC'.

Note the query already includes a GROUP BY on the context fields, so if your joins result in multiple rows, you can use aggregate functions in the ORDER BY. See forum for an example.

Return values

string[] Array with 2 elements; extra joins for the query, and ORDER BY value

◆ get_course_level_context_restriction_sql()

core_search\base::get_course_level_context_restriction_sql	(	?\context	$context,
			$coursetable,
			$paramtype = SQL_PARAMS_QM )

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.

Parameters

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)

Return values

array Array with SQL and parameters; both null if no need to query

Exceptions

coding_exception If called with invalid params

◆ get_doc_icon()

core_search\base_block::get_doc_icon ( document $doc )

Returns an icon instance for the document.

Parameters

core_search\document $doc

Return values

core_search\document_icon

Reimplemented from core_search\base.

◆ get_doc_url()

core_search\base_block::get_doc_url ( \core_search\document $doc )

Returns a url to the document, it might match self\get_context_url().

Parameters

core_search\document $doc

Return values

moodle_url

Reimplemented from core_search\base.

◆ get_document()

core_search\base::get_document	(		$record,
			$options = array() )

abstractinherited

Returns the document related with the provided record.

This method receives a record with the document id and other info returned by get_recordset_by_timestamp or get_recordset_by_contexts that might be useful here. The idea is to restrict database queries to minimum as this function will be called for each document to index. As an alternative, use cached data.

Internally it should use core_search\document to standarise the documents before sending them to the search engine.

Search areas should send plain text to the search engine, use the following function to convert any user input data to plain text: content_to_text

Valid keys for the options array are: indexfiles => File indexing is enabled if true. lastindexedtime => The last time this area was indexed. 0 if never indexed.

The lastindexedtime value is not set if indexing a specific context rather than the whole system.

Parameters

stdClass	$record	A record containing, at least, the indexed document id and a modified timestamp
array	$options	Options for document creation

Return values

core_search\document

Reimplemented in block_html\search\content, core_course\search\course, core_course\search\customfield, core_course\search\section, core_message\search\base_message, core_message\search\message_received, core_message\search\message_sent, core_search\base_activity, core_user\search\course_teacher, core_user\search\user, mod_bigbluebuttonbn\search\tags, mod_book\search\chapter, mod_data\search\entry, mod_forum\search\post, mod_glossary\search\entry, mod_page\search\activity, mod_url\search\activity, and mod_wiki\search\collaborative_page.

◆ get_document_display_title()

core_search\base::get_document_display_title ( \core_search\document $doc )

inherited

Returns the document title to display.

Allow to customize the document title string to display.

Parameters

core_search\document $doc

Return values

string Document title to display in the search results page

◆ get_document_recordset()

core_search\base_block::get_document_recordset	(		$modifiedfrom = 0,
		context	$context = null )

Gets recordset of all blocks of this type modified since given time within the given context.

See base class for detailed requirements. This implementation includes the key fields from block_instances.

This can be overridden to do something totally different if the block's data is stored in other tables.

If there are certain instances of the block which should not be included in the search index then you can override get_indexing_restrictions; by default this excludes rows with empty configdata.

Parameters

int	$modifiedfrom	Return only records modified after this date
context \| null	$context	Context to find blocks within

Return values

false|moodle_recordset|null

Reimplemented from core_search\base.

◆ get_indexing_restrictions()

core_search\base_block::get_indexing_restrictions ( )

protected

Returns restrictions on which block_instances rows to return.

By default, excludes rows that have empty configdata.

If no restriction is required, you could return ['', []].

Return values

array 2-element array of SQL restriction and params for it

◆ get_last_indexing_duration()

core_search\base::get_last_indexing_duration ( )

inherited

Gets the length of time spent indexing this area (the last time it was indexed).

Return values

int|bool Time in seconds spent indexing this area last time, false if never indexed

◆ get_levels()

static core_search\base::get_levels ( )

staticinherited

Returns context levels property.

Return values

int

◆ get_recordset_by_timestamp()

core_search\base::get_recordset_by_timestamp ( $modifiedfrom = 0 )

inherited

Returns a recordset ordered by modification date ASC.

Each record can include any data self\get_document might need but it must:

Include an 'id' field: Unique identifier (in this area's scope) of a document to index in the search engine If the indexed content field can contain embedded files, the 'id' value should match the filearea itemid.
Only return data modified since $modifiedfrom, including $modifiedform to prevent some records from not being indexed (e.g. your-timemodified-fieldname >= $modifiedfrom)
Order the returned data by time modified in ascending order, as core_search\manager will need to store the modified time of the last indexed document.

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.

Parameters

int $modifiedfrom

Return values

moodle_recordset

◆ get_search_fileareas()

core_search\base::get_search_fileareas ( )

inherited

Return the context info required to index files for this search area.

Should be onerridden by each search area.

Return values

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.

◆ get_settingnames()

static core_search\base::get_settingnames ( )

staticinherited

Return a list of all required setting names.

Return values

array

◆ get_visible_name()

core_search\base::get_visible_name ( $lazyload = false )

inherited

Returns the area visible name.

Parameters

bool $lazyload Usually false, unless when in admin settings.

Return values

string

◆ is_enabled()

core_search\base::is_enabled ( )

inherited

Is the search component enabled by the system administrator?

Return values

bool

◆ is_supported_page_type_at_course_context()

static core_search\base_block::is_supported_page_type_at_course_context ( $pagetype )

staticprotected

Checks if a page type is supported for blocks when at course (or also site) context.

This function should be consistent with the SQL in get_recordset_by_timestamp.

Parameters

string $pagetype Page type

Return values

bool	True if supported

◆ supports_get_document_recordset()

core_search\base::supports_get_document_recordset ( )

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.

◆ uses_file_indexing()

core_search\base::uses_file_indexing ( )

inherited

Returns true if this area uses file indexing.

Return values

bool

Member Data Documentation

◆ $levels

array core_search\base_block::$levels = [CONTEXT_BLOCK]

staticprotected

The context levels the search area is working on.

This can be overwriten by the search area if it works at multiple levels.

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

search/classes/base_block.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ attach_files()

◆ check_access()

◆ clear_static()

◆ get_area_id()

◆ get_block_instance()

◆ get_block_name()

◆ get_category_names()

◆ get_component_name()

◆ get_component_type()

◆ get_config()

◆ get_config_var_name()

◆ get_context_restriction_sql()

◆ get_context_url()

◆ get_contexts_to_reindex()

◆ get_contexts_to_reindex_extra_sql()

◆ get_course_level_context_restriction_sql()

◆ get_doc_icon()

◆ get_doc_url()

◆ get_document()

◆ get_document_display_title()

◆ get_document_recordset()

◆ get_indexing_restrictions()

◆ get_last_indexing_duration()

◆ get_levels()

◆ get_recordset_by_timestamp()

◆ get_search_fileareas()

◆ get_settingnames()

◆ get_visible_name()

◆ is_enabled()

◆ is_supported_page_type_at_course_context()

◆ supports_get_document_recordset()

◆ uses_file_indexing()

Member Data Documentation

◆ $levels