Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
restore_course_search Class Reference

A course search component. More...

Inheritance diagram for restore_course_search:
restore_search_base renderable import_course_search

Public Member Functions

 __construct (array $config=array(), $currentcouseid=null)
 Constructor.
 
 get_count ()
 The total number of results.
 
 get_results ()
 Returns an array of results from the search.
 
 get_search ()
 The current search string.
 
moodle_page get_url ()
 The URL for this search $PAGE.
 
 get_varsearch ()
 Returns the name the search variable should use.
 
 has_more_results ()
 Returns true if there are more search results.
 
 invalidate_results ()
 Invalidates the results collected so far.
 
 require_capability ($capability, $user=null)
 Adds a required capability which all results will be checked against.
 
moodle_database search ()
 Executes the search.
 
 set_include_currentcourse ()
 Returns true if the current course should be included in the results.
 
 set_url (moodle_url $url)
 Sets the page URL.
 

Public Attributes

const DEFAULT_SEARCH = ''
 The default values for this components params.
 

Static Public Attributes

static string $VAR_SEARCH = 'search'
 

Protected Member Functions

 format_results ()
 Formats results.
 
 get_itemcontextlevel ()
 Gets the context level for the search result items.
 
moodle_database get_searchsql ()
 Get the search SQL.
 
 setup_restrictions ()
 Sets up any access restrictions for the courses to be displayed in the search.
 

Protected Attributes

int $currentcourseid = null
 The current course id.
 
bool $includecurrentcourse
 Determines if the current course is included in the results.
 

Detailed Description

A course search component.

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

Constructor & Destructor Documentation

◆ __construct()

restore_course_search::__construct ( array $config = array(),
$currentcouseid = null )

Constructor.

Parameters
array$config
int$currentcouseidThe current course id so it can be ignored

Member Function Documentation

◆ format_results()

restore_course_search::format_results ( )
protected

Formats results.

Reimplemented from restore_search_base.

◆ get_count()

restore_search_base::get_count ( )
finalinherited

The total number of results.

Return values
int

◆ get_itemcontextlevel()

restore_course_search::get_itemcontextlevel ( )
protected

Gets the context level for the search result items.

Return values
CONTEXT_|int

Reimplemented from restore_search_base.

◆ get_results()

restore_search_base::get_results ( )
finalinherited

Returns an array of results from the search.

Return values
array

◆ get_search()

restore_search_base::get_search ( )
finalinherited

The current search string.

Return values
string

◆ get_searchsql()

moodle_database restore_course_search::get_searchsql ( )
protected

Get the search SQL.

$DB

Return values
array

Reimplemented from restore_search_base.

◆ get_url()

moodle_page restore_search_base::get_url ( )
finalinherited

The URL for this search $PAGE.

Return values
moodle_urlThe URL for this page

◆ get_varsearch()

restore_course_search::get_varsearch ( )

Returns the name the search variable should use.

Return values
string

Reimplemented from restore_search_base.

◆ has_more_results()

restore_search_base::has_more_results ( )
finalinherited

Returns true if there are more search results.

Return values
bool

◆ require_capability()

restore_search_base::require_capability ( $capability,
$user = null )
finalinherited

Adds a required capability which all results will be checked against.

Parameters
string$capability
int | null$user

◆ search()

moodle_database restore_search_base::search ( )
finalinherited

Executes the search.

$DB

Return values
intThe number of results

◆ set_url()

restore_search_base::set_url ( moodle_url $url)
finalinherited

Sets the page URL.

Parameters
moodle_url$url

◆ setup_restrictions()

restore_course_search::setup_restrictions ( )
protected

Sets up any access restrictions for the courses to be displayed in the search.

This will typically call $this->require_capability().

Reimplemented in import_course_search.


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