[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/backup/util/ui/ -> restore_ui_components.php (summary)

This file contains components used by the restore UI

Copyright: 2010 Sam Hemelryk
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 351 lines (11 kb)
Included or required:0 times
Referenced: 1 time
Includes or requires: 0 files

Defines 2 classes

restore_course_search:: (7 methods):
  __construct()
  setup_restrictions()
  get_searchsql()
  get_itemcontextlevel()
  format_results()
  get_varsearch()
  set_include_currentcourse()

restore_category_search:: (5 methods):
  __construct()
  get_searchsql()
  get_itemcontextlevel()
  format_results()
  get_varsearch()

Defines 5 functions

  __construct()
  get_url()
  get_search()
  get_count()
  get_results()
  set_url()
  invalidate_results()
  require_capability()
  search()
  has_more_results()

Class: restore_course_search  - X-Ref

A course search component

__construct(array $config=array()   X-Ref

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

setup_restrictions()   X-Ref
Sets up any access restrictions for the courses to be displayed in the search.

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

get_searchsql()   X-Ref


get_itemcontextlevel()   X-Ref
No description

format_results()   X-Ref
No description

get_varsearch()   X-Ref
No description

set_include_currentcourse()   X-Ref
No description

Class: restore_category_search  - X-Ref

A category search component

__construct(array $config=array()   X-Ref
No description

get_searchsql()   X-Ref


get_itemcontextlevel()   X-Ref
No description

format_results()   X-Ref
No description

get_varsearch()   X-Ref
No description

Functions
Functions that are not part of a class:

__construct(array $config=array()   X-Ref
Constructor

param: array $config Config options

get_url()   X-Ref
The URL for this search

return: moodle_url The URL for this page

get_search()   X-Ref
The current search string

return: string

get_count()   X-Ref
The total number of results

return: int

get_results()   X-Ref
Returns an array of results from the search

return: array

set_url(moodle_url $url)   X-Ref
Sets the page URL

param: moodle_url $url

invalidate_results()   X-Ref
Invalidates the results collected so far


require_capability($capability, $user=null)   X-Ref
Adds a required capability which all results will be checked against

param: string $capability
param: int|null $user

search()   X-Ref
Executes the search

return: int The number of results

has_more_results()   X-Ref
No description



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1