Base class for restoring all advanced grading form plugins.
More...
|
| static | define_plugin_decode_contents () |
| | Define the contents in the plugin that must be processed by the link decoder.
|
| |
| static | get_restore_decode_contents ($plugintype) |
| | Returns one array with all the decode contents to be processed by the links decoder.
|
| |
| static | itemid_mapping ($areaname) |
| | Helper method returning the mapping identifierto use for grading form instance's itemid field.
|
| |
|
|
| add_related_files ($component, $filearea, $mappingitemname, $filesctxid=null, $olditemid=null) |
| | Add all the existing file, given their component and filearea and one backup_ids itemname to match with.
|
| |
|
| apply_date_offset ($value) |
| | Apply course startdate offset based in original course startdate and course_offset_startdate setting Note we are using one static cache here, but by restoreid, so it's ok for concurrence/multiple executions in the same request.
|
| |
|
| get_mapping ($itemname, $oldid) |
| | Return the complete mapping from the given itemname, itemid.
|
| |
| | get_mappingid ($itemname, $oldid, $ifnotfound=false) |
| | Return the new id of a mapping for the given itemname.
|
| |
|
| get_namefor ($name='') |
| | Simple helper function that returns the name for the restore_path_element It's not mandatory to use it but recommended ;-)
|
| |
|
| get_new_parentid ($itemname) |
| | Returns the latest (parent) new id mapped by one pathelement.
|
| |
|
| get_old_parentid ($itemname) |
| | Returns the latest (parent) old id mapped by one pathelement.
|
| |
| | get_pathfor ($path='') |
| | Simple helper function that returns the base (prefix) of the path for the restore_path_element Useful if we used get_recommended_name() in backup.
|
| |
|
| get_restoreid () |
| |
|
| get_setting_value ($name) |
| | Returns the value of one (task/plan) setting.
|
| |
| | get_task () |
| | Get the task we are part of.
|
| |
| | set_mapping ($itemname, $oldid, $newid, $restorefiles=false, $filesctxid=null, $parentid=null) |
| | To send ids pairs to backup_ids_table and to store them into paths.
|
| |
Base class for restoring all advanced grading form plugins.
As an example of implementation see restore_gradingform_rubric_plugin
- Copyright
- 2011 David Mudrak david.nosp@m.@moo.nosp@m.dle.c.nosp@m.om
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ define_plugin_decode_contents()
| static restore_plugin::define_plugin_decode_contents |
( |
| ) |
|
|
staticinherited |
Define the contents in the plugin that must be processed by the link decoder.
Reimplemented in restore_qtype_plugin.
◆ get_mappingid()
| restore_plugin::get_mappingid |
( |
| $itemname, |
|
|
| $oldid, |
|
|
| $ifnotfound = false ) |
|
protectedinherited |
Return the new id of a mapping for the given itemname.
- Parameters
-
| string | $itemname | the type of item |
| int | $oldid | the item ID from the backup |
| mixed | $ifnotfound | what to return if $oldid wasnt found. Defaults to false |
◆ get_pathfor()
| restore_plugin::get_pathfor |
( |
| $path = '' | ) |
|
|
protectedinherited |
Simple helper function that returns the base (prefix) of the path for the restore_path_element Useful if we used get_recommended_name() in backup.
It's not mandatory to use it but recommended ;-)
◆ get_restore_decode_contents()
| static restore_plugin::get_restore_decode_contents |
( |
| $plugintype | ) |
|
|
staticinherited |
Returns one array with all the decode contents to be processed by the links decoder.
This method, given one plugin type, returns one array of restore_decode_content objects that will be added to the restore decoder in order to perform modifications under the plugin contents.
The objects are retrieved by calling to the define_decode_contents method (when available), first in the main restore_xxxx_plugin class and later on each of the available subclasses
◆ get_task()
| restore_plugin::get_task |
( |
| ) |
|
|
protectedinherited |
Get the task we are part of.
- Return values
-
| restore_activity_task|restore_course_task | the task. |
◆ itemid_mapping()
| static restore_gradingform_plugin::itemid_mapping |
( |
| $areaname | ) |
|
|
static |
Helper method returning the mapping identifierto use for grading form instance's itemid field.
- Parameters
-
| array | $areaname | the name of the area the form is defined for |
- Return values
-
| string | the mapping identifier |
◆ launch_after_execute_methods()
| restore_plugin::launch_after_execute_methods |
( |
| ) |
|
|
inherited |
after_execute dispatcher for any restore_plugin class
This method will dispatch execution to the corresponding after_execute_xxx() method when available, with xxx being the connection point of the instance, so plugin classes with multiple connection points will support multiple after_execute methods, one for each connection point
◆ launch_after_restore_methods()
| restore_plugin::launch_after_restore_methods |
( |
| ) |
|
|
inherited |
after_restore dispatcher for any restore_plugin class
This method will dispatch execution to the corresponding after_restore_xxx() method when available, with xxx being the connection point of the instance, so plugin classes with multiple connection points will support multiple after_restore methods, one for each connection point
◆ set_mapping()
| restore_plugin::set_mapping |
( |
| $itemname, |
|
|
| $oldid, |
|
|
| $newid, |
|
|
| $restorefiles = false, |
|
|
| $filesctxid = null, |
|
|
| $parentid = null ) |
|
protectedinherited |
To send ids pairs to backup_ids_table and to store them into paths.
This method will send the given itemname and old/new ids to the backup_ids_temp table, and, at the same time, will save the new id into the corresponding restore_path_element for easier access by children. Also will inject the known old context id for the task in case it's going to be used for restoring files later
The documentation for this class was generated from the following file:
- backup/moodle2/restore_gradingform_plugin.class.php
1.11.0