restore_course_search Class Reference

Inheritance diagram for restore_course_search:

Collaboration diagram for restore_course_search:

Public Member Functions
	__construct (array $config=array(), $currentcouseid=null)
	get_varsearch ()
	set_include_currentcourse ()
Static Public Attributes
static	$VAR_SEARCH = 'search'
Protected Member Functions
	setup_restrictions ()
	get_searchsql ()
	get_itemcontextlevel ()
	format_results ()
Protected Attributes
	$currentcourseid = null
	$includecurrentcourse

---

Detailed Description

A course search component

Definition at line 216 of file restore_ui_components.php.

---

Constructor & Destructor Documentation

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

Parameters:

array	$config
int	$currentcouseid	The current course id so it can be ignored

Definition at line 227 of file restore_ui_components.php.

Here is the call graph for this function:

---

Member Function Documentation

format_results

(

)

[protected]

Formats the results

Reimplemented from restore_search_base.

Definition at line 270 of file restore_ui_components.php.

get_itemcontextlevel

(

)

[protected]

Gets the context level associated with this components items

Returns:

CONTEXT_*

Reimplemented from restore_search_base.

Definition at line 267 of file restore_ui_components.php.

get_searchsql

(

)

[protected]

moodle_database $DB

Reimplemented from restore_search_base.

Definition at line 245 of file restore_ui_components.php.

Here is the call graph for this function:

get_varsearch

(

)

Gets the string used to transfer the search string for this compontents requests

Returns:

string

Reimplemented from restore_search_base.

Definition at line 271 of file restore_ui_components.php.

set_include_currentcourse

(

)

Definition at line 274 of file restore_ui_components.php.

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.

Definition at line 238 of file restore_ui_components.php.

Here is the call graph for this function:

Here is the caller graph for this function:

---

Field Documentation

$currentcourseid = null [protected]

Definition at line 220 of file restore_ui_components.php.

$includecurrentcourse [protected]

Definition at line 221 of file restore_ui_components.php.

$VAR_SEARCH = 'search' [static]

Reimplemented from restore_search_base.

Definition at line 218 of file restore_ui_components.php.

---

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

• C:/xampp/htdocs/moodle/backup/util/ui/restore_ui_components.php