Merge pull request #50 from tlock/master

Fixed deprecated step "I check" for 2.7

classes/event/attendance_taken_by_student.php

@@ -0,0 +1,104 @@
+<?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/>.
+
+/**
+ * This file contains an event for when an attendance is taken.
+ *
+ * @package    mod_attendance
+ * @copyright  2014 onwards Dan Marsden
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_attendance\event;
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Event for when an attendance is taken.
+ *
+ * @property-read array $other {
+ *      Extra information about event properties.
+ *
+ *      @string mode Mode of the report viewed.
+ * }
+ * @package    mod_attendance
+ * @since      Moodle 2.7
+ * @copyright  2013 onwards Dan Marsden
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class attendance_taken_by_student extends \core\event\base {
+
+    /**
+     * Init method.
+     */
+    protected function init() {
+        $this->data['crud'] = 'r';
+        $this->data['edulevel'] = self::LEVEL_TEACHING;
+        $this->data['objecttable'] = 'attendance';
+    }
+
+    /**
+     * Returns non-localised description of what happened.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return 'Student with id ' . $this->userid . ' took attendance with instanceid ' .
+            $this->objectid;
+    }
+
+    /**
+     * Returns localised general event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventtakenbystudent', 'mod_attendance');
+    }
+
+    /**
+     * Get URL related to the action
+     *
+     * @return \moodle_url
+     */
+    public function get_url() {
+        return new \moodle_url('/take.php', array('id' => $this->contextinstanceid,
+                                                                 'sessionid' => $this->other['sessionid'],
+                                                                 'grouptype' => $this->other['grouptype']));
+    }
+
+    /**
+     * Replace add_to_log() statement.
+     *
+     * @return array of parameters to be passed to legacy add_to_log() function.
+     */
+    protected function get_legacy_logdata() {
+        return array($this->courseid, 'attendance', 'taken', $this->get_url(),
+            '', $this->contextinstanceid);
+    }
+
+    /**
+     * Custom validation.
+     *
+     * @throws \coding_exception
+     * @return void
+     */
+    protected function validate_data() {
+        if (empty($this->other['sessionid'])) {
+            throw new \coding_exception('The event mod_attendance\\event\\attendance_taken must specify sessionid.');
+        }
+        parent::validate_data();
+    }
+}

lang/en/attendance.php

@@ -216,10 +216,11 @@ $string['week'] = 'week(s)';
 $string['weeks'] = 'Weeks';
 $string['youcantdo'] = 'You can\'t do anything';
 
-$string['eventreportviewed'] = 'Report viewed';
+$string['eventreportviewed'] = 'Attendance report viewed';
 $string['eventsessionadded'] = 'Session added';
 $string['eventsessionupdated'] = 'Session updated';
 $string['eventtaken'] = 'Attendance taken';
+$string['eventtakenbystudent'] = 'Attendance taken by student';
 $string['eventsessiondeleted'] = 'Session deleted';
 $string['eventdurationupdated'] = 'Session duration updated';
 $string['eventstatusupdated'] = 'Status updated';

locallib.php

@@ -900,7 +900,7 @@ class attendance {
                 'grouptype' => 0);
                
         // Log the change.
-        $event = \mod_attendance\event\attendance_taken::create(array(
+        $event = \mod_attendance\event\attendance_taken_by_student::create(array(
             'objectid' => $this->id,
             'context' => $this->context,
             'other' => $params));

tests/behat/attendance_mod.feature

@@ -36,7 +36,7 @@ Feature: Teachers and Students can record session attendance
         And I follow "Course 1"
         And I follow "Attendance"
         And I follow "Add"
-        And I check "Allow students to record own attendance"
+        And I set the field "Allow students to record own attendance" to "1"
         And I set the following fields to these values:
             | id_sessiondate_hour | 23 |
         And I click on "id_submitbutton" "button"
@@ -46,7 +46,7 @@ Feature: Teachers and Students can record session attendance
         And I follow "Course 1"
         And I follow "Attendance"
         And I follow "Submit attendance"
-        And I check "Present"
+        And I set the field "Present" to "1"
         And I press "Save changes"
         Then I should see "Self-recorded"
         And I log out
@@ -55,7 +55,7 @@ Feature: Teachers and Students can record session attendance
         And I expand "Reports" node
         And I follow "Logs"
         And I click on "Get these logs" "button"
-        Then "attendance taken by student" "link" should exist
+        Then "Attendance taken by student" "link" should exist
 
     Scenario: Teachers can view low grade report and send a message
         When I log in as "teacher1"
@@ -68,14 +68,14 @@ Feature: Teachers and Students can record session attendance
         And I follow "Continue"
         And I follow "Report"
         And I follow "Low grade"
-        And I check "user3"
+        And I set the field "user3" to "1"
         And I click on "Send a message" "button"
         Then I should see "Message body"
         And I should see "student1@asd.com"
         And I expand "Reports" node
         And I follow "Logs"
         And I click on "Get these logs" "button"
-        Then "attendance report viewed" "link" should exist
+        Then "Attendance report viewed" "link" should exist
 
     # Dependency - selenium running with firefox profile with auto saving of txt files to $CFG->behat_download.
     @javascript @_file_download
@@ -92,9 +92,9 @@ Feature: Teachers and Students can record session attendance
         Then the "id_ident_idnumber" checkbox should not be checked
         And the "id_ident_institution" checkbox should not be checked
         And the "id_ident_department" checkbox should not be checked
-        And I check "id_ident_idnumber"
-        And I check "id_ident_institution"
-        And I check "id_ident_department"
+        And I set the field "id_ident_idnumber" to "1"
+        And I set the field "id_ident_institution" to "1"
+        And I set the field "id_ident_department" to "1"
         And I set the following fields to these values:
             | format | Download in text format |
         And I click on "OK" "button"

tests/behat/attendance_taken_by_student.php

@@ -0,0 +1,104 @@
+<?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/>.
+
+/**
+ * This file contains an event for when an attendance is taken.
+ *
+ * @package    mod_attendance
+ * @copyright  2014 onwards Dan Marsden
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_attendance\event;
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Event for when an attendance is taken.
+ *
+ * @property-read array $other {
+ *      Extra information about event properties.
+ *
+ *      @string mode Mode of the report viewed.
+ * }
+ * @package    mod_attendance
+ * @since      Moodle 2.7
+ * @copyright  2013 onwards Dan Marsden
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class attendance_taken_by_student extends \core\event\base {
+
+    /**
+     * Init method.
+     */
+    protected function init() {
+        $this->data['crud'] = 'r';
+        $this->data['edulevel'] = self::LEVEL_TEACHING;
+        $this->data['objecttable'] = 'attendance';
+    }
+
+    /**
+     * Returns non-localised description of what happened.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return 'Student with id ' . $this->userid . ' took attendance with instanceid ' .
+            $this->objectid;
+    }
+
+    /**
+     * Returns localised general event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventtakenbystudent', 'mod_attendance');
+    }
+
+    /**
+     * Get URL related to the action
+     *
+     * @return \moodle_url
+     */
+    public function get_url() {
+        return new \moodle_url('/mod/attendance/take.php', array('id' => $this->contextinstanceid,
+                                                                 'sessionid' => $this->other['sessionid'],
+                                                                 'grouptype' => $this->other['grouptype']));
+    }
+
+    /**
+     * Replace add_to_log() statement.
+     *
+     * @return array of parameters to be passed to legacy add_to_log() function.
+     */
+    protected function get_legacy_logdata() {
+        return array($this->courseid, 'attendance', 'taken', $this->get_url(),
+            '', $this->contextinstanceid);
+    }
+
+    /**
+     * Custom validation.
+     *
+     * @throws \coding_exception
+     * @return void
+     */
+    protected function validate_data() {
+        if (empty($this->other['sessionid'])) {
+            throw new \coding_exception('The event mod_attendance\\event\\attendance_taken must specify sessionid.');
+        }
+        parent::validate_data();
+    }
+}