MDL-30998: updated docblocks for backup of advanced grading
[moodle.git] / backup / moodle2 / restore_gradingform_plugin.class.php
CommitLineData
37065c2e 1<?php
37065c2e
DM
2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
17/**
fa4c60c1
MG
18 * Contains class restore_gradingform_plugin responsible for advanced grading form plugin backup
19 *
20 * @package core_backup
f9dab4be 21 * @subpackage moodle2
fa4c60c1
MG
22 * @copyright 2011 David Mudrak <david@moodle.com>
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37065c2e
DM
24 */
25
26defined('MOODLE_INTERNAL') || die();
27
28/**
fa4c60c1
MG
29 * Base class for restoring all advanced grading form plugins
30 *
31 * As an example of implementation see {@link restore_gradingform_rubric_plugin}
32 *
33 * @copyright 2011 David Mudrak <david@moodle.com>
34 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35 * @category backup
37065c2e
DM
36 */
37abstract class restore_gradingform_plugin extends restore_plugin {
38
39 /**
40 * Helper method returning the mapping identifierto use for
41 * grading form instance's itemid field
42 *
43 * @param array $areaname the name of the area the form is defined for
44 * @return string the mapping identifier
45 */
46 public static function itemid_mapping($areaname) {
47 return 'grading_item_'.$areaname;
48 }
49}