Inheritance diagram for core_backup_renderer:

Collaboration diagram for core_backup_renderer:

Public Member Functions
	progress_bar (array $items)
	dependency_notification ($message)
	backup_details ($details, $nextstageurl)
	backup_details_nonstandard ($nextstageurl, array $details)
	backup_details_unknown (moodle_url $nextstageurl)
	course_selector (moodle_url $nextstageurl, $wholecourse=true, restore_category_search $categories=null, restore_course_search $courses=null, $currentcourse=null)
	import_course_selector (moodle_url $nextstageurl, import_course_search $courses=null)
	precheck_notices ($results)
	substage_buttons ($haserrors)
	role_mappings ($rolemappings, $roles)
	continue_button ($url, $method='post')
	backup_files_viewer (array $options=null)
	render_backup_files_viewer (backup_files_viewer $viewer)
	render_restore_course_search (restore_course_search $component)
	render_import_course_search (import_course_search $component)
	render_restore_category_search (restore_category_search $component)
Protected Member Functions
	backup_detail_pair ($label, $value)
	backup_detail_input ($label, $type, $name, $value, array $attributes=array(), $description=null)
	backup_detail_select ($label, $name, $options, $selected='', $nothing=false, array $attributes=array(), $description=null)

Detailed Description

The primary renderer for the backup.

Can be retrieved with the following code: <?php $renderer = $PAGE->get_renderer('core','backup'); ?>

Copyright:: 2010 Sam Hemelryk http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Definition at line 37 of file renderer.php.

Member Function Documentation

backup_detail_input	(	$	label,
		$	type,
		$	name,
		$	value,
		array $	attributes = `array()`,
		$	description = `null`
	)		`[protected]`

Created a detailed pairing with an input

Parameters:

string	$label
string	$type
string	$name
string	$value
array	$attributes
string \| null	$description

Returns:: string

Definition at line 338 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

backup_detail_pair	(	$	label,
		$	value
	)		`[protected]`

Creates a detailed pairing (key + value)

int $count

Parameters:

string	$label
string	$value

Returns:: string

Definition at line 317 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

backup_detail_select	(	$	label,
		$	name,
		$	options,
		$	selected = `''`,
		$	nothing = `false`,
		array $	attributes = `array()`,
		$	description = `null`
	)		`[protected]`

Creates a detailed pairing with a select

Parameters:

string	$label
string	$name
array	$options
string	$selected
bool	$nothing
array	$attributes
string \| null	$description

Returns:: string

Definition at line 359 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

backup_details	(	$	details,
		$	nextstageurl
	)

Displays the details of a backup file

Parameters:

stdClass	$details
moodle_url	$nextstageurl

Returns:: string

Definition at line 74 of file renderer.php.

Here is the call graph for this function:

backup_details_nonstandard	(	$	nextstageurl,
		array $	details
	)

Displays the general information about a backup file with non-standard format

Parameters:

moodle_url	$nextstageurl	URL to send user to
array	$details	basic info about the file (format, type)

Returns:: string HTML code to display

Definition at line 167 of file renderer.php.

Here is the call graph for this function:

backup_details_unknown ( moodle_url $ nextstageurl )

Displays the general information about a backup file with unknown format

Parameters:

moodle_url $nextstageurl URL to send user to

Returns:: string HTML code to display

Definition at line 192 of file renderer.php.

Here is the call graph for this function:

backup_files_viewer ( array $ options = null )

Print a backup files tree

Parameters:

array $options

Returns:: string

Definition at line 450 of file renderer.php.

Here is the call graph for this function:

continue_button	(	$	url,
		$	method = `'post'`
	)

Displays a continue button

Parameters:

string \| moodle_url	$url
string	$method

Returns:: string

Definition at line 433 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

course_selector	(	moodle_url $	nextstageurl,
		$	wholecourse = `true`,
		restore_category_search $	categories = `null`,
		restore_course_search $	courses = `null`,
		$	currentcourse = `null`
	)

Displays a course selector for restore

Parameters:

moodle_url	$nextstageurl
bool	$wholecourse	true if we are restoring whole course (as with backup::TYPE_1COURSE), false otherwise
restore_category_search	$categories
restore_course_search	$courses
int	$currentcourse

Returns:: string

Definition at line 213 of file renderer.php.

Here is the call graph for this function:

dependency_notification ( $ message )

Prints a dependency notification

Parameters:

string $message

Returns:: string

Definition at line 63 of file renderer.php.

Here is the call graph for this function:

import_course_selector	(	moodle_url $	nextstageurl,
		import_course_search $	courses = `null`
	)

Displays the import course selector

Parameters:

moodle_url	$nextstageurl
import_course_search	$courses

Returns:: string

Definition at line 291 of file renderer.php.

Here is the call graph for this function:

precheck_notices ( $ results )

Displays precheck notices

Parameters:

array $results

Returns:: string

Definition at line 374 of file renderer.php.

Here is the call graph for this function:

progress_bar ( array $ items )

Renderers a progress bar for the backup or restore given the items that make it up.

Parameters:

array $items An array of items

Returns:: string

Definition at line 44 of file renderer.php.

Here is the call graph for this function:

render_backup_files_viewer ( backup_files_viewer $ viewer )

Displays a backup files viewer

stdClass $USER

Parameters:

backup_files_viewer $tree

Returns:: string

Definition at line 462 of file renderer.php.

Here is the call graph for this function:

render_import_course_search ( import_course_search $ component )

Renders an import course search object

Parameters:

import_course_search $component

Returns:: string

Definition at line 565 of file renderer.php.

Here is the call graph for this function:

render_restore_category_search ( restore_category_search $ component )

Renders a restore category search object

Parameters:

restore_category_search $component

Returns:: string

Definition at line 613 of file renderer.php.

Here is the call graph for this function:

render_restore_course_search ( restore_course_search $ component )

Renders a restore course search object

Parameters:

restore_course_search $component

Returns:: string

Definition at line 508 of file renderer.php.

Here is the call graph for this function:

role_mappings	(	$	rolemappings,
		$	roles
	)

Displays a role mapping interface

Parameters:

array	$rolemappings
array	$roles

Returns:: string

Definition at line 412 of file renderer.php.

Here is the call graph for this function:

substage_buttons ( $ haserrors )

Displays substage buttons

Parameters:

bool $haserrors

Returns:: string

Definition at line 395 of file renderer.php.

Here is the call graph for this function:

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

C:/xampp/htdocs/moodle/backup/util/ui/renderer.php

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation