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

The primary renderer for the backup. More...

Inheritance diagram for core_backup_renderer:
plugin_renderer_base renderer_base

Public Member Functions

 __call ($method, $arguments)
 Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.
 
 add_action_handler (component_action $action, $id=null)
 Adds a JS action for the element with the provided id.
 
 backup_details ($details, $nextstageurl)
 Displays the details of a backup file.
 
 backup_details_nonstandard ($nextstageurl, array $details)
 Displays the general information about a backup file with non-standard format.
 
 backup_details_unknown (moodle_url $nextstageurl)
 Displays the general information about a backup file with unknown format.
 
 backup_files_viewer (array $options=null)
 Print a backup files tree.
 
 continue_button ($url, $method='post')
 Displays a continue button, overriding core renderer method of the same in order to override submission method of the button form.
 
 copy_progress_viewer (int $userid, int $courseid)
 Get markup to render table for all of a users course copies.
 
 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.
 
 dependency_notification ($message)
 Prints a dependency notification.
 
 get_compact_logo_url ($maxwidth=300, $maxheight=300)
 Return the site's compact logo URL, if any.
 
 get_logo_url ($maxwidth=null, $maxheight=200)
 Return the site's logo URL, if any.
 
 get_samesite_notification ()
 Get the same site backup notification.
 
 get_status_display ($statuscode, $backupid, $restoreid=null, $operation='backup')
 Generate the status indicator markup for display in the backup restore file area UI.
 
 has_started ()
 Returns true is output has already started, and false if not.
 
 image_url ($imagename, $component='moodle')
 Return the moodle_url for an image.
 
 import_course_selector (moodle_url $nextstageurl, import_course_search $courses=null)
 Displays the import course selector.
 
 log_display ($loghtml)
 The backup and restore pages may display a log (if any) in a scrolling box.
 
 pix_url ($imagename, $component='moodle')
 Return the direct URL for an image from the pix folder.
 
 precheck_notices ($results)
 Displays precheck notices.
 
 progress_bar (array $items)
 Renderers a progress bar for the backup or restore given the items that make it up.
 
 render (renderable $widget)
 Renders the provided widget and returns the HTML to display it.
 
stdClass render_backup_files_viewer (backup_files_viewer $viewer)
 Displays a backup files viewer.
 
 render_from_template ($templatename, $context)
 Renders a template by name with the given context.
 
 render_import_course_search (import_course_search $component)
 Renders an import course search object.
 
 render_restore_category_search (restore_category_search $component)
 Renders a restore category search object.
 
 render_restore_course_search (restore_course_search $component)
 Renders a restore course search object.
 
 restore_progress_viewer ($userid, $context)
 Get markup to render table for all of a users async in progress restores.
 
 role_mappings ($rolemappings, $roles)
 Displays a role mapping interface.
 
 set_samesite_notification ()
 Set the same site backup notification.
 
 should_display_main_logo ($headinglevel=1)
 Whether we should display the main logo.
 
 should_display_navbar_logo ()
 Whether we should display the logo in the navbar.
 
 substage_buttons ($haserrors)
 Displays substage buttons.
 

Static Public Member Functions

static prepare_classes ($classes)
 Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.
 

Protected Member Functions

 backup_detail_input ($label, $type, $name, $value, array $attributes=array(), $description=null)
 Created a detailed pairing with an input.
 
 backup_detail_pair ($label, $value)
 Creates a detailed pairing (key + value)
 
 backup_detail_select ($label, $name, $options, $selected='', $nothing=false, array $attributes=array(), $description=null)
 Creates a detailed pairing with a select.
 
 get_mustache ()
 Return an instance of the mustache class.
 
 make_unique_id (string $prefix)
 Creates a unique id string by appending an incremental number to the prefix.
 

Protected Attributes

xhtml_container_stack $opencontainers
 The xhtml_container_stack to use.
 
renderer_base core_renderer $output
 A reference to the current renderer.
 
moodle_page $page
 The Moodle page the renderer has been created to assist with.
 
string $target
 The requested rendering target.
 
array $templatecache = []
 $templatecache The mustache template cache.
 

Detailed Description

The primary renderer for the backup.

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

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

Member Function Documentation

◆ __call()

plugin_renderer_base::__call ( $method,
$arguments )
inherited

Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.

Parameters
string$method
array$arguments
Return values
mixed

◆ add_action_handler()

renderer_base::add_action_handler ( component_action $action,
$id = null )
inherited

Adds a JS action for the element with the provided id.

This method adds a JS event for the provided component action to the page and then returns the id that the event has been attached to. If no id has been provided then a new ID is generated by html_writer::random_id()

Parameters
component_action$action
string$id
Return values
stringid of element, either original submitted or random new if not supplied

◆ backup_detail_input()

core_backup_renderer::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
Return values
string

◆ backup_detail_pair()

core_backup_renderer::backup_detail_pair ( $label,
$value )
protected

Creates a detailed pairing (key + value)

@staticvar int $count

Parameters
string$label
string$value
Return values
string

◆ backup_detail_select()

core_backup_renderer::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
Return values
string

◆ backup_details()

core_backup_renderer::backup_details ( $details,
$nextstageurl )

Displays the details of a backup file.

Parameters
stdClass$details
moodle_url$nextstageurl
Return values
string

◆ backup_details_nonstandard()

core_backup_renderer::backup_details_nonstandard ( $nextstageurl,
array $details )

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

Parameters
moodle_url$nextstageurlURL to send user to
array$detailsbasic info about the file (format, type)
Return values
stringHTML code to display

◆ backup_details_unknown()

core_backup_renderer::backup_details_unknown ( moodle_url $nextstageurl)

Displays the general information about a backup file with unknown format.

Parameters
moodle_url$nextstageurlURL to send user to
Return values
stringHTML code to display

◆ backup_files_viewer()

core_backup_renderer::backup_files_viewer ( array $options = null)

Print a backup files tree.

Parameters
array$options
Return values
string

◆ continue_button()

core_backup_renderer::continue_button ( $url,
$method = 'post' )

Displays a continue button, overriding core renderer method of the same in order to override submission method of the button form.

Parameters
string | moodle_url$url
string$method
Return values
string

◆ copy_progress_viewer()

core_backup_renderer::copy_progress_viewer ( int $userid,
int $courseid )

Get markup to render table for all of a users course copies.

Parameters
int$useridThe Moodle user id.
int$courseidThe id of the course to get the backups for.
Return values
string\$htmlThe table HTML.

◆ course_selector()

core_backup_renderer::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$wholecoursetrue if we are restoring whole course (as with backup\TYPE_1COURSE), false otherwise
restore_category_search$categories
restore_course_search$courses
int$currentcourse
Return values
string

◆ dependency_notification()

core_backup_renderer::dependency_notification ( $message)

Prints a dependency notification.

Parameters
string$message
Return values
string

◆ get_compact_logo_url()

renderer_base::get_compact_logo_url ( $maxwidth = 300,
$maxheight = 300 )
inherited

Return the site's compact logo URL, if any.

Parameters
int$maxwidthThe maximum width, or null when the maximum width does not matter.
int$maxheightThe maximum height, or null when the maximum height does not matter.
Return values
moodle_url|false

◆ get_logo_url()

renderer_base::get_logo_url ( $maxwidth = null,
$maxheight = 200 )
inherited

Return the site's logo URL, if any.

Parameters
int$maxwidthThe maximum width, or null when the maximum width does not matter.
int$maxheightThe maximum height, or null when the maximum height does not matter.
Return values
moodle_url|false

◆ get_mustache()

renderer_base::get_mustache ( )
protectedinherited

Return an instance of the mustache class.

Since
2.9
Return values
Mustache_Engine

◆ get_status_display()

core_backup_renderer::get_status_display ( $statuscode,
$backupid,
$restoreid = null,
$operation = 'backup' )

Generate the status indicator markup for display in the backup restore file area UI.

Parameters
int$statuscodeThe status code of the backup.
string$backupidThe backup record id.
Return values
string|boolean\$statusThe status indicator for the operation.

◆ has_started()

renderer_base::has_started ( )
inherited

Returns true is output has already started, and false if not.

Return values
booleantrue if the header has been printed.

◆ image_url()

renderer_base::image_url ( $imagename,
$component = 'moodle' )
inherited

Return the moodle_url for an image.

The exact image location and extension is determined automatically by searching for gif|png|jpg|jpeg, please note there can not be diferent images with the different extension. The imagename is for historical reasons a relative path name, it may be changed later for core images. It is recommended to not use subdirectories in plugin and theme pix directories.

There are three types of images: 1/ theme images - stored in theme/mytheme/pix/, use component 'theme' 2/ core images - stored in /pix/, overridden via theme/mytheme/pix_core/ 3/ plugin images - stored in mod/mymodule/pix, overridden via theme/mytheme/pix_plugins/mod/mymodule/, example: image_url('comment', 'mod_glossary')

Parameters
string$imagenamethe pathname of the image
string$componentfull plugin name (aka component) or 'theme'
Return values
moodle_url

◆ import_course_selector()

core_backup_renderer::import_course_selector ( moodle_url $nextstageurl,
import_course_search $courses = null )

Displays the import course selector.

Parameters
moodle_url$nextstageurl
import_course_search$courses
Return values
string

◆ log_display()

core_backup_renderer::log_display ( $loghtml)

The backup and restore pages may display a log (if any) in a scrolling box.

Parameters
string$loghtmlLog content in HTML format
Return values
stringHTML content that shows the log

◆ make_unique_id()

core_backup_renderer::make_unique_id ( string $prefix)
protected

Creates a unique id string by appending an incremental number to the prefix.

Parameters
string$prefixTo be used as the left part of the id string.
Return values
string

◆ pix_url()

renderer_base::pix_url ( $imagename,
$component = 'moodle' )
inherited

Return the direct URL for an image from the pix folder.

Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.

Deprecated
since Moodle 3.3
Parameters
string$imagenamethe name of the icon.
string$componentspecification of one plugin like in get_string()
Return values
moodle_url

◆ precheck_notices()

core_backup_renderer::precheck_notices ( $results)

Displays precheck notices.

Parameters
array$results
Return values
string

◆ prepare_classes()

static renderer_base::prepare_classes ( $classes)
staticinherited

Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.

Parameters
mixed$classesSpace-separated string or array of classes
Return values
stringHTML class attribute value

◆ progress_bar()

core_backup_renderer::progress_bar ( array $items)

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

Parameters
array$itemsAn array of items
Return values
string

◆ render()

plugin_renderer_base::render ( renderable $widget)
inherited

Renders the provided widget and returns the HTML to display it.

Parameters
renderable$widgetinstance with renderable interface
Return values
string

Reimplemented from renderer_base.

Reimplemented in core_courseformat\output\section_renderer, and tool_policy\output\renderer.

◆ render_backup_files_viewer()

stdClass core_backup_renderer::render_backup_files_viewer ( backup_files_viewer $viewer)

Displays a backup files viewer.

$USER

Parameters
backup_files_viewer$viewer
Return values
string

◆ render_from_template()

renderer_base::render_from_template ( $templatename,
$context )
inherited

Renders a template by name with the given context.

The provided data needs to be array/stdClass made up of only simple types. Simple types are array,stdClass,bool,int,float,string

Since
2.9
Parameters
array | stdClass$contextContext containing data for the template.
Return values
string|boolean

◆ render_import_course_search()

core_backup_renderer::render_import_course_search ( import_course_search $component)

Renders an import course search object.

Parameters
import_course_search$component
Return values
string

◆ render_restore_category_search()

core_backup_renderer::render_restore_category_search ( restore_category_search $component)

Renders a restore category search object.

Parameters
restore_category_search$component
Return values
string

◆ render_restore_course_search()

core_backup_renderer::render_restore_course_search ( restore_course_search $component)

Renders a restore course search object.

Parameters
restore_course_search$component
Return values
string

◆ restore_progress_viewer()

core_backup_renderer::restore_progress_viewer ( $userid,
$context )

Get markup to render table for all of a users async in progress restores.

Parameters
int$useridThe Moodle user id.
context$contextThe Moodle context for these restores.
Return values
string\$htmlThe table HTML.

◆ role_mappings()

core_backup_renderer::role_mappings ( $rolemappings,
$roles )

Displays a role mapping interface.

Parameters
array$rolemappings
array$roles
Return values
string

◆ should_display_main_logo()

renderer_base::should_display_main_logo ( $headinglevel = 1)
inherited

Whether we should display the main logo.

Deprecated
since Moodle 4.0
Todo
final deprecation. To be removed in Moodle 4.4 MDL-73165.
Parameters
int$headinglevelThe heading level we want to check against.
Return values
bool

◆ should_display_navbar_logo()

renderer_base::should_display_navbar_logo ( )
inherited

Whether we should display the logo in the navbar.

We will when there are no main logos, and we have compact logo.

Return values
bool

◆ substage_buttons()

core_backup_renderer::substage_buttons ( $haserrors)

Displays substage buttons.

Parameters
bool$haserrors
Return values
string

Member Data Documentation

◆ $output

renderer_base core_renderer plugin_renderer_base::$output
protectedinherited

A reference to the current renderer.

The renderer provided here will be determined by the page but will in 90% of cases by the core_renderer


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