From f159ad7302777c726f170d78ebcc79513254985d Mon Sep 17 00:00:00 2001 From: rwijaya Date: Wed, 9 Oct 2013 20:14:26 +0800 Subject: [PATCH] MDL-41131 assign module: remove setting for submission comments and edipdf plugins' setting. --- mod/assign/assignmentplugin.php | 10 ++++ mod/assign/feedback/editpdf/locallib.php | 21 ++++++++ mod/assign/locallib.php | 8 ++- mod/assign/submission/comments/locallib.php | 20 ++++++++ mod/assign/submission/comments/settings.php | 28 ---------- mod/assign/tests/locallib_test.php | 57 +++++++++++++++++++++ mod/assign/tests/upgradelib_test.php | 36 +++++++++++-- 7 files changed, 146 insertions(+), 34 deletions(-) delete mode 100644 mod/assign/submission/comments/settings.php diff --git a/mod/assign/assignmentplugin.php b/mod/assign/assignmentplugin.php index ea6a36af9e8..52ab2f90487 100644 --- a/mod/assign/assignmentplugin.php +++ b/mod/assign/assignmentplugin.php @@ -636,4 +636,14 @@ abstract class assign_plugin { public function get_external_parameters() { return null; } + + /** + * If true, the plugin will appear on the module settings page and can be + * enabled/disabled per assignment instance. + * + * @return bool + */ + public function is_configurable() { + return true; + } } diff --git a/mod/assign/feedback/editpdf/locallib.php b/mod/assign/feedback/editpdf/locallib.php index d1d3cf57c91..c7372bfd2f0 100644 --- a/mod/assign/feedback/editpdf/locallib.php +++ b/mod/assign/feedback/editpdf/locallib.php @@ -253,4 +253,25 @@ class assign_feedback_editpdf extends assign_feedback_plugin { return true; } + /** + * Automatically enable or disable editpdf feedback plugin based on + * whether the ghostscript path is set correctly. + * + * @return bool + */ + public function is_enabled() { + $testpath = assignfeedback_editpdf\pdf::test_gs_path(); + if ($testpath->status == assignfeedback_editpdf\pdf::GSPATH_OK) { + return true; + } + return false; + } + /** + * Automatically hide the setting for the editpdf feedback plugin. + * + * @return bool false + */ + public function is_configurable() { + return false; + } } diff --git a/mod/assign/locallib.php b/mod/assign/locallib.php index aa513671c5d..2ec6da602c0 100644 --- a/mod/assign/locallib.php +++ b/mod/assign/locallib.php @@ -967,8 +967,12 @@ class assign { */ protected function add_plugin_settings(assign_plugin $plugin, MoodleQuickForm $mform, & $pluginsenabled) { global $CFG; - if ($plugin->is_visible()) { - + if ($plugin->is_visible() && !$plugin->is_configurable() && $plugin->is_enabled()) { + $name = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled'; + $pluginsenabled[] = $mform->createElement('hidden', $name, 1); + $mform->setType($name, PARAM_BOOL); + $plugin->get_settings($mform); + } else if ($plugin->is_visible() && $plugin->is_configurable()) { $name = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled'; $label = $plugin->get_name(); $label .= ' ' . $this->get_renderer()->help_icon('enabled', $plugin->get_subtype() . '_' . $plugin->get_type()); diff --git a/mod/assign/submission/comments/locallib.php b/mod/assign/submission/comments/locallib.php index 52fbfda0feb..787f3f5f666 100644 --- a/mod/assign/submission/comments/locallib.php +++ b/mod/assign/submission/comments/locallib.php @@ -168,4 +168,24 @@ class assign_submission_comments extends assign_submission_plugin { public function allow_submissions() { return false; } + + /** + * Automatically enable or disable this plugin based on "$CFG->commentsenabled" + * + * @return bool + */ + public function is_enabled() { + global $CFG; + + return (!empty($CFG->usecomments)); + } + + /** + * Automatically hide the setting for the submission plugin. + * + * @return bool + */ + public function is_configurable() { + return false; + } } diff --git a/mod/assign/submission/comments/settings.php b/mod/assign/submission/comments/settings.php deleted file mode 100644 index 53412bf4dc9..00000000000 --- a/mod/assign/submission/comments/settings.php +++ /dev/null @@ -1,28 +0,0 @@ -. - -/** - * This file defines the admin settings for this plugin - * - * @package assignsubmission_comments - * @copyright 2012 NetSpot {@link http://www.netspot.com.au} - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later - */ - -$settings->add(new admin_setting_configcheckbox('assignsubmission_comments/default', - new lang_string('default', 'assignsubmission_comments'), - new lang_string('default_help', 'assignsubmission_comments'), 0)); - diff --git a/mod/assign/tests/locallib_test.php b/mod/assign/tests/locallib_test.php index ed10b0643ff..341dfca1c31 100644 --- a/mod/assign/tests/locallib_test.php +++ b/mod/assign/tests/locallib_test.php @@ -1378,5 +1378,62 @@ class mod_assign_locallib_testcase extends mod_assign_base_testcase { $this->assertNotContains($output, get_string('submitassignment', 'assign'), 'Should not be able to submit after cutoff date.'); } + /** + * Testing for submission comment plugin settings + */ + public function test_submission_comment_plugin_settings() { + global $CFG; + + $commentconfig = false; + if (!empty($CFG->usecomments)) { + $commentconfig = $CFG->usecomments; + } + + $CFG->usecomments = true; + $assign = $this->create_instance(); + $plugin = $assign->get_submission_plugin_by_type('comments'); + $this->assertEquals(1, $plugin->is_enabled('enabled')); + + $assign = $this->create_instance(array('assignsubmission_comments_enabled' => 0)); + $plugin = $assign->get_submission_plugin_by_type('comments'); + $this->assertEquals(1, $plugin->is_enabled('enabled')); + + $assign = $this->create_instance(array('assignsubmission_comments_enabled' => 1)); + $plugin = $assign->get_submission_plugin_by_type('comments'); + $this->assertEquals(1, $plugin->is_enabled('enabled')); + + $CFG->usecomments = false; + $assign = $this->create_instance(); + $plugin = $assign->get_submission_plugin_by_type('comments'); + $this->assertEquals(0, $plugin->is_enabled('enabled')); + + $assign = $this->create_instance(array('assignsubmission_comments_enabled' => 0)); + $plugin = $assign->get_submission_plugin_by_type('comments'); + $this->assertEquals(0, $plugin->is_enabled('enabled')); + + $assign = $this->create_instance(array('assignsubmission_comments_enabled' => 1)); + $plugin = $assign->get_submission_plugin_by_type('comments'); + $this->assertEquals(0, $plugin->is_enabled('enabled')); + + $CFG->usecomments = $commentconfig; + } + + /** + * Testing for feedback comment plugin settings + */ + public function test_feedback_plugin_settings() { + + $assign = $this->create_instance(); + $plugin = $assign->get_feedback_plugin_by_type('comments'); + $this->assertEquals(0, $plugin->is_enabled('enabled')); + + $assign = $this->create_instance(array('assignfeedback_comments_enabled' => 0)); + $plugin = $assign->get_feedback_plugin_by_type('comments'); + $this->assertEquals(0, $plugin->is_enabled('enabled')); + + $assign = $this->create_instance(array('assignfeedback_comments_enabled' => 1)); + $plugin = $assign->get_feedback_plugin_by_type('comments'); + $this->assertEquals(1, $plugin->is_enabled('enabled')); + } } diff --git a/mod/assign/tests/upgradelib_test.php b/mod/assign/tests/upgradelib_test.php index 263cc1da985..2df6e74e7c8 100644 --- a/mod/assign/tests/upgradelib_test.php +++ b/mod/assign/tests/upgradelib_test.php @@ -46,7 +46,13 @@ class mod_assign_upgradelib_testcase extends mod_assign_base_testcase { } public function test_upgrade_upload_assignment() { - global $DB; + global $DB, $CFG; + + $commentconfig = false; + if (!empty($CFG->usecomments)) { + $commentconfig = $CFG->usecomments; + } + $CFG->usecomments = false; $this->setUser($this->editingteachers[0]); $generator = $this->getDataGenerator()->get_plugin_generator('mod_assignment'); @@ -81,11 +87,18 @@ class mod_assign_upgradelib_testcase extends mod_assign_base_testcase { $plugin = $assign->get_feedback_plugin_by_type('offline'); $this->assertEmpty($plugin->is_enabled()); + $CFG->usecomments = $commentconfig; course_delete_module($cm->id); } public function test_upgrade_uploadsingle_assignment() { - global $DB; + global $DB, $CFG; + + $commentconfig = false; + if (!empty($CFG->usecomments)) { + $commentconfig = $CFG->usecomments; + } + $CFG->usecomments = false; $this->setUser($this->editingteachers[0]); $generator = $this->getDataGenerator()->get_plugin_generator('mod_assignment'); @@ -120,11 +133,18 @@ class mod_assign_upgradelib_testcase extends mod_assign_base_testcase { $plugin = $assign->get_feedback_plugin_by_type('offline'); $this->assertEmpty($plugin->is_enabled()); + $CFG->usecomments = $commentconfig; course_delete_module($cm->id); } public function test_upgrade_onlinetext_assignment() { - global $DB; + global $DB, $CFG; + + $commentconfig = false; + if (!empty($CFG->usecomments)) { + $commentconfig = $CFG->usecomments; + } + $CFG->usecomments = false; $this->setUser($this->editingteachers[0]); $generator = $this->getDataGenerator()->get_plugin_generator('mod_assignment'); @@ -159,11 +179,18 @@ class mod_assign_upgradelib_testcase extends mod_assign_base_testcase { $plugin = $assign->get_feedback_plugin_by_type('offline'); $this->assertEmpty($plugin->is_enabled()); + $CFG->usecomments = $commentconfig; course_delete_module($cm->id); } public function test_upgrade_offline_assignment() { - global $DB; + global $DB, $CFG; + + $commentconfig = false; + if (!empty($CFG->usecomments)) { + $commentconfig = $CFG->usecomments; + } + $CFG->usecomments = false; $this->setUser($this->editingteachers[0]); $generator = $this->getDataGenerator()->get_plugin_generator('mod_assignment'); @@ -198,6 +225,7 @@ class mod_assign_upgradelib_testcase extends mod_assign_base_testcase { $plugin = $assign->get_feedback_plugin_by_type('offline'); $this->assertEmpty($plugin->is_enabled()); + $CFG->usecomments = $commentconfig; course_delete_module($cm->id); } }