This is the destination stage.
More...
|
null restore_category_search | $categorysearch = null |
| The category search component.
|
|
int | $contextid |
| The context ID.
|
|
null | $courseid = null |
| The course ID.
|
|
null restore_course_search | $coursesearch = null |
| The course search component.
|
|
mixed null | $filepath = null |
| The backup file path.
|
|
int | $target = backup::TARGET_NEW_COURSE |
| The restore target.
|
|
This is the destination stage.
This stage is the second stage and is also independent
- Copyright
- 2010 Sam Hemelryk
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ __construct()
restore_ui_stage_destination::__construct |
( |
| $contextid | ) |
|
◆ display()
◆ get_course_id()
restore_ui_stage_destination::get_course_id |
( |
| ) |
|
Returns the course id.
- Return values
-
◆ get_filepath()
restore_ui_stage_destination::get_filepath |
( |
| ) |
|
Returns the backup file path.
- Return values
-
◆ get_progress_bar()
restore_ui_independent_stage::get_progress_bar |
( |
| ) |
|
|
inherited |
Gets an array of progress bar items that can be displayed through the restore renderer.
- Return values
-
array | Array of items for the progress bar |
◆ get_progress_reporter()
restore_ui_independent_stage::get_progress_reporter |
( |
| ) |
|
|
inherited |
Gets the progress reporter object in use for this restore UI stage.
IMPORTANT: This progress reporter is used only for UI progress that is outside the restore controller. The restore controller has its own progress reporter which is used for progress during the main restore. Use the restore controller's progress reporter to report progress during a restore operation, not this one.
This extra reporter is necessary because on some restore UI screens, there are long-running tasks even though there is no restore controller in use. There is a similar function in restore_ui. but that class is not used on some stages.
- Return values
-
◆ get_stage()
restore_ui_stage_destination::get_stage |
( |
| ) |
|
◆ get_stage_name()
restore_ui_stage_destination::get_stage_name |
( |
| ) |
|
◆ get_target()
restore_ui_stage_destination::get_target |
( |
| ) |
|
Returns the target for this restore.
One of backup\TARGET_*
- Return values
-
◆ is_independent()
restore_ui_independent_stage::is_independent |
( |
| ) |
|
|
finalinherited |
Obviously true.
- Return values
-
◆ process()
restore_ui_stage_destination::process |
( |
| ) |
|
◆ set_progress_reporter()
restore_ui_independent_stage::set_progress_reporter |
( |
\core\progress\base | $progressreporter | ) |
|
|
inherited |
Sets the progress reporter that will be returned by get_progress_reporter.
- Parameters
-
◆ $target
int restore_ui_stage_destination::$target = backup::TARGET_NEW_COURSE |
|
protected |
The restore target.
One of backup\TARGET_NEW
The documentation for this class was generated from the following file:
- backup/util/ui/restore_ui_stage.class.php