 |
Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
|
|
Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
|
The primary renderer for the backup. More...
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. | |
The primary renderer for the backup.
Can be retrieved with the following code: <?php $renderer = $PAGE->get_renderer('core', 'backup'); ?>
|
inherited |
Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.
| string | $method | |
| array | $arguments |
| mixed |
|
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()
| component_action | $action | |
| string | $id |
| string | id of element, either original submitted or random new if not supplied |
|
protected |
Created a detailed pairing with an input.
| string | $label | |
| string | $type | |
| string | $name | |
| string | $value | |
| array | $attributes | |
| string | null | $description |
| string |
|
protected |
Creates a detailed pairing (key + value)
@staticvar int $count
| string | $label | |
| string | $value |
| string |
|
protected |
Creates a detailed pairing with a select.
| string | $label | |
| string | $name | |
| array | $options | |
| string | $selected | |
| bool | $nothing | |
| array | $attributes | |
| string | null | $description |
| string |
| core_backup_renderer::backup_details | ( | $details, | |
| $nextstageurl ) |
Displays the details of a backup file.
| stdClass | $details | |
| moodle_url | $nextstageurl |
| string |
| core_backup_renderer::backup_details_nonstandard | ( | $nextstageurl, | |
| array | $details ) |
Displays the general information about a backup file with non-standard format.
| moodle_url | $nextstageurl | URL to send user to |
| array | $details | basic info about the file (format, type) |
| string | HTML code to display |
| core_backup_renderer::backup_details_unknown | ( | moodle_url | $nextstageurl | ) |
Displays the general information about a backup file with unknown format.
| moodle_url | $nextstageurl | URL to send user to |
| string | HTML code to display |
| core_backup_renderer::backup_files_viewer | ( | array | $options = null | ) |
Print a backup files tree.
| array | $options |
| string |
| 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.
| string | moodle_url | $url | |
| string | $method |
| string |
| core_backup_renderer::copy_progress_viewer | ( | int | $userid, |
| int | $courseid ) |
Get markup to render table for all of a users course copies.
| int | $userid | The Moodle user id. |
| int | $courseid | The id of the course to get the backups for. |
| string\$html | The table HTML. |
| 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.
| 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 |
| string |
| core_backup_renderer::dependency_notification | ( | $message | ) |
Prints a dependency notification.
| string | $message |
| string |
|
inherited |
Return the site's compact logo URL, if any.
| int | $maxwidth | The maximum width, or null when the maximum width does not matter. |
| int | $maxheight | The maximum height, or null when the maximum height does not matter. |
| moodle_url|false |
|
inherited |
Return the site's logo URL, if any.
| int | $maxwidth | The maximum width, or null when the maximum width does not matter. |
| int | $maxheight | The maximum height, or null when the maximum height does not matter. |
| moodle_url|false |
|
protectedinherited |
| 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.
| int | $statuscode | The status code of the backup. |
| string | $backupid | The backup record id. |
| string|boolean\$status | The status indicator for the operation. |
|
inherited |
Returns true is output has already started, and false if not.
| boolean | true if the header has been printed. |
|
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')
| string | $imagename | the pathname of the image |
| string | $component | full plugin name (aka component) or 'theme' |
| moodle_url |
| core_backup_renderer::import_course_selector | ( | moodle_url | $nextstageurl, |
| import_course_search | $courses = null ) |
Displays the import course selector.
| moodle_url | $nextstageurl | |
| import_course_search | $courses |
| string |
| core_backup_renderer::log_display | ( | $loghtml | ) |
The backup and restore pages may display a log (if any) in a scrolling box.
| string | $loghtml | Log content in HTML format |
| string | HTML content that shows the log |
|
protected |
Creates a unique id string by appending an incremental number to the prefix.
| string | $prefix | To be used as the left part of the id string. |
| string |
|
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.
| string | $imagename | the name of the icon. |
| string | $component | specification of one plugin like in get_string() |
| moodle_url |
| core_backup_renderer::precheck_notices | ( | $results | ) |
Displays precheck notices.
| array | $results |
| string |
|
staticinherited |
Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.
| mixed | $classes | Space-separated string or array of classes |
| string | HTML class attribute value |
| core_backup_renderer::progress_bar | ( | array | $items | ) |
Renderers a progress bar for the backup or restore given the items that make it up.
| array | $items | An array of items |
| string |
|
inherited |
Renders the provided widget and returns the HTML to display it.
| renderable | $widget | instance with renderable interface |
| string |
Reimplemented from renderer_base.
Reimplemented in core_courseformat\output\section_renderer, and tool_policy\output\renderer.
| stdClass core_backup_renderer::render_backup_files_viewer | ( | backup_files_viewer | $viewer | ) |
|
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
| array | stdClass | $context | Context containing data for the template. |
| string|boolean |
| core_backup_renderer::render_import_course_search | ( | import_course_search | $component | ) |
Renders an import course search object.
| import_course_search | $component |
| string |
| core_backup_renderer::render_restore_category_search | ( | restore_category_search | $component | ) |
Renders a restore category search object.
| restore_category_search | $component |
| string |
| core_backup_renderer::render_restore_course_search | ( | restore_course_search | $component | ) |
Renders a restore course search object.
| restore_course_search | $component |
| string |
| core_backup_renderer::restore_progress_viewer | ( | $userid, | |
| $context ) |
| core_backup_renderer::role_mappings | ( | $rolemappings, | |
| $roles ) |
Displays a role mapping interface.
| array | $rolemappings | |
| array | $roles |
| string |
|
inherited |
Whether we should display the main logo.
| int | $headinglevel | The heading level we want to check against. |
| bool |
|
inherited |
Whether we should display the logo in the navbar.
We will when there are no main logos, and we have compact logo.
| bool |
| core_backup_renderer::substage_buttons | ( | $haserrors | ) |
Displays substage buttons.
| bool | $haserrors |
| string |
|
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
1.11.0