MDL-46569 gradereport_history: Create a helper class

Part of MDL-46191
2014-08-22 10:33:15 +08:00
parent e1db69e957
commit 91737ef389
1 changed files with 78 additions and 0 deletions
@@ -0,0 +1,78 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Helper class for gradehistory report.
+ *
+ * @package    gradereport_history
+ * @copyright  2014 onwards Ankit Agarwal <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace gradereport_history;
+
+defined('MOODLE_INTERNAL') || die;
+
+/**
+ * Helper class for gradehistory report.
+ *
+ * @since      Moodle 2.8
+ * @package    gradereport_history
+ * @copyright  2014 onwards Ankit Agarwal <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class helper {
+    /**
+     * Get an instance of the user select button {@link gradereport_history_user_button}.
+     *
+     * @param int $courseid       course id.
+     * @param array $currentusers List of currently selected users.
+     *
+     * @return output\user_button the user select button.
+     */
+    public static function get_user_select_button($courseid, $currentusers = array()) {
+        global $PAGE;
+        $button = new output\user_button($PAGE->url, get_string('selectuser', 'gradereport_history'), 'get');
+        $button->class .= ' gradereport_history_plugin';
+
+        $modules = array('moodle-gradereport_history-quickselect', 'moodle-gradereport_history-quickselect-skin');
+        $arguments = array(
+            'courseid' => $courseid,
+            'ajaxurl' => '/grade/report/history/ajax.php',
+            'url' => $PAGE->url->out(false),
+            'userfullnames' => $currentusers,
+        );
+
+        $function = 'M.gradereport_history.quickselect.init';
+        $button->require_yui_module($modules, $function, array($arguments));
+        $button->strings_for_js(array(
+            'ajaxoneuserfound',
+            'ajaxxusersfound',
+            'ajaxnext25',
+            'errajaxsearch',
+            'none',
+            'usersearch'
+        ), 'enrol');
+        $button->strings_for_js(array(
+            'deselect',
+            'selectuser',
+            'finishselectingusers',
+        ), 'gradereport_history');
+        $button->strings_for_js('select');
+
+        return $button;
+    }
+}