MDL-40055 mod_assign: Replace add_to_log 'set marking workflow state'

mod/assign/classes/event/workflow_state_updated.php

@@ -0,0 +1,115 @@
+<?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/>.
+
+/**
+ * mod_assign workflow state updated event.
+ *
+ * @package    mod_assign
+ * @copyright  2013 Frédéric Massart
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_assign\event;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * mod_assign workflow state updated event class.
+ *
+ * @package    mod_assign
+ * @copyright  2013 Frédéric Massart
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class workflow_state_updated extends \core\event\base {
+
+    /**
+     * Legacy log data.
+     *
+     * @var array
+     */
+    protected $legacylogdata;
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return "User {$this->userid} has set the workflow state of {$this->relateduserid} to {$this->other['newstate']}.";
+    }
+
+    /**
+     * Return legacy data for add_to_log().
+     *
+     * @return array
+     */
+    public function get_legacy_logdata() {
+        return $this->legacylogdata;
+    }
+
+    /**
+     * Return localised event name.
+     *
+     * @return \lang_string
+     */
+    public static function get_name() {
+        return new \lang_string('event_workflow_state_updated', 'mod_assign');
+    }
+
+    /**
+     * Get URL related to the action
+     *
+     * @return \moodle_url
+     */
+    public function get_url() {
+        return new \moodle_url('/mod/assign/view.php', array('id' => $this->context->instanceid));
+    }
+
+    /**
+     * Init method.
+     *
+     * @return void
+     */
+    protected function init() {
+        $this->data['crud'] = 'u';
+        $this->data['level'] = 50;          // TODO MDL-37658.
+        $this->data['objecttable'] = 'assign';
+    }
+
+    /**
+     * Sets the legacy event log data.
+     *
+     * @param stdClass $legacylogdata legacy log data.
+     * @return void
+     */
+    public function set_legacy_logdata($legacylogdata) {
+        $this->legacylogdata = $legacylogdata;
+    }
+
+    /**
+     * Custom validation.
+     *
+     * @throws coding_exception
+     * @return void
+     */
+    protected function validate_data() {
+        if (!isset($this->other['newstate'])) {
+            throw new coding_exception('newstate must be set in $other.');
+        } else if (!isset($this->relateduserid)) {
+            throw new coding_exception('relateduserid must be set.');
+        }
+    }
+}

mod/assign/lang/en/assign.php

@@ -147,6 +147,7 @@ $string['event_identities_revealed'] = 'The identities have been revealed.';
 $string['event_marker_updated'] = 'The allocated marker has been updated.';
 $string['event_submission_locked'] = 'The submissions have been locked for a user.';
 $string['event_submission_status_updated'] = 'The status of the submission has been updated.';
+$string['event_workflow_state_updated'] = 'The state of the workflow has been updated.';
 $string['extensionduedate'] = 'Extension due date';
 $string['extensionnotafterduedate'] = 'Extension date must be after the due date';
 $string['extensionnotafterfromdate'] = 'Extension date must be after the allow submissions from date';

mod/assign/locallib.php

@@ -5722,7 +5722,7 @@ class assign {
      *
      * @return void
      */
-    private function process_set_batch_marking_workflow_state() {
+    protected function process_set_batch_marking_workflow_state() {
         global $DB;
 
         require_sesskey();
@@ -5753,7 +5753,18 @@ class assign {
                                 'fullname'=>fullname($user),
                                 'state'=>$state);
                 $message = get_string('setmarkingworkflowstateforlog', 'assign', $params);
-                $this->add_to_log('set marking workflow state', $message);
+                $addtolog = $this->add_to_log('set marking workflow state', $message, '', true);
+                $params = array(
+                    'context' => $this->context,
+                    'objectid' => $this->get_instance()->id,
+                    'relateduserid' => $userid,
+                    'other' => array(
+                        'newstate' => $state
+                    )
+                );
+                $event = \mod_assign\event\workflow_state_updated::create($params);
+                $event->set_legacy_logdata($addtolog);
+                $event->trigger();
             }
         }
     }

mod/assign/tests/base_test.php

@@ -271,6 +271,14 @@ class testable_assign extends assign {
         return parent::process_set_batch_marking_allocation();
     }
 
+    public function testable_process_set_batch_marking_workflow_state($selectedusers, $state) {
+        // Ugly hack to get something into the method.
+        global $_POST;
+        $_POST['selectedusers'] = $selectedusers;
+        $_POST['markingworkflowstate'] = $state;
+        return parent::process_set_batch_marking_workflow_state();
+    }
+
     public function testable_submissions_open($userid = 0) {
         return parent::submissions_open($userid);
     }

mod/assign/tests/locallib_test.php

@@ -1108,5 +1108,39 @@ class mod_assign_locallib_testcase extends mod_assign_base_testcase {
         $this->editingteachers[0]->ignoresesskey = false;
     }
 
+    public function test_workflow_state_updated_event() {
+        $this->editingteachers[0]->ignoresesskey = true;
+        $this->setUser($this->editingteachers[0]);
+
+        $assign = $this->create_instance();
+
+        $sink = $this->redirectEvents();
+        $assign->testable_process_set_batch_marking_workflow_state($this->students[0]->id, ASSIGN_MARKING_WORKFLOW_STATE_INREVIEW);
+
+        $events = $sink->get_events();
+        $this->assertCount(1, $events);
+        $event = reset($events);
+        $this->assertInstanceOf('\mod_assign\event\workflow_state_updated', $event);
+        $this->assertEquals($assign->get_context(), $event->get_context());
+        $this->assertEquals($assign->get_instance()->id, $event->objectid);
+        $this->assertEquals($this->students[0]->id, $event->relateduserid);
+        $this->assertEquals($this->editingteachers[0]->id, $event->userid);
+        $this->assertEquals(ASSIGN_MARKING_WORKFLOW_STATE_INREVIEW, $event->other['newstate']);
+        $expected = array(
+            $assign->get_course()->id,
+            'assign',
+            'set marking workflow state',
+            'view.php?id=' . $assign->get_course_module()->id,
+            get_string('setmarkingworkflowstateforlog', 'assign', array('id' => $this->students[0]->id,
+                'fullname' => fullname($this->students[0]), 'state' => ASSIGN_MARKING_WORKFLOW_STATE_INREVIEW)),
+            $assign->get_course_module()->id,
+            $this->editingteachers[0]->id
+        );
+        $this->assertEventLegacyLogData($expected, $event);
+        $sink->close();
+
+        // Revert to defaults.
+        $this->editingteachers[0]->ignoresesskey = false;
+    }
 }