From 0e5deb201882df3d16753a29289fde7a858fb89d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20S=CC=8Ckoda?= Date: Wed, 16 Apr 2014 17:03:35 +0800 Subject: [PATCH] MDL-41101 tidy up the phpdocs in new assign events --- .../batch_set_marker_allocation_viewed.php | 21 +++++++++-------- .../event/batch_set_workflow_state_viewed.php | 21 +++++++++-------- .../course_module_instance_list_viewed.php | 9 +++++++- mod/assign/classes/event/feedback_updated.php | 17 ++++++++++---- mod/assign/classes/event/feedback_viewed.php | 23 ++++++++++--------- .../classes/event/grading_form_viewed.php | 23 ++++++++++--------- .../classes/event/grading_table_viewed.php | 21 +++++++++-------- ...al_identities_confirmation_page_viewed.php | 21 +++++++++-------- .../submission_confirmation_form_viewed.php | 21 +++++++++-------- .../classes/event/submission_form_viewed.php | 23 ++++++++++--------- .../event/submission_status_viewed.php | 21 +++++++++-------- .../classes/event/submission_viewed.php | 23 ++++++++++--------- 12 files changed, 140 insertions(+), 104 deletions(-) diff --git a/mod/assign/classes/event/batch_set_marker_allocation_viewed.php b/mod/assign/classes/event/batch_set_marker_allocation_viewed.php index 3b1e65ae6a2..d0b93c06a85 100644 --- a/mod/assign/classes/event/batch_set_marker_allocation_viewed.php +++ b/mod/assign/classes/event/batch_set_marker_allocation_viewed.php @@ -14,6 +14,18 @@ // You should have received a copy of the GNU General Public License // along with Moodle. If not, see . +/** + * The mod_assign batch set marker allocation viewed event. + * + * @package mod_assign + * @copyright 2014 Mark Nelson + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +namespace mod_assign\event; + +defined('MOODLE_INTERNAL') || die(); + /** * The mod_assign batch set marker allocation viewed event. * @@ -28,11 +40,6 @@ * @copyright 2014 Mark Nelson * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ - -namespace mod_assign\event; - -defined('MOODLE_INTERNAL') || die(); - class batch_set_marker_allocation_viewed extends base { /** @var \assign */ protected $assign; @@ -45,8 +52,6 @@ class batch_set_marker_allocation_viewed extends base { /** * Create instance of event. * - * @since Moodle 2.7 - * * @param \assign $assign * @return batch_set_marker_allocation_viewed */ @@ -70,8 +75,6 @@ class batch_set_marker_allocation_viewed extends base { * * NOTE: to be used from observers only. * - * @since Moodle 2.7 - * * @return \assign */ public function get_assign() { diff --git a/mod/assign/classes/event/batch_set_workflow_state_viewed.php b/mod/assign/classes/event/batch_set_workflow_state_viewed.php index ccf83db7ac4..42c86811c49 100644 --- a/mod/assign/classes/event/batch_set_workflow_state_viewed.php +++ b/mod/assign/classes/event/batch_set_workflow_state_viewed.php @@ -14,6 +14,18 @@ // You should have received a copy of the GNU General Public License // along with Moodle. If not, see . +/** + * The mod_assign assignment batch set workflow stated viewed event. + * + * @package mod_assign + * @copyright 2014 Mark Nelson + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +namespace mod_assign\event; + +defined('MOODLE_INTERNAL') || die(); + /** * The mod_assign assignment batch set workflow stated viewed event. * @@ -28,11 +40,6 @@ * @copyright 2014 Mark Nelson * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ - -namespace mod_assign\event; - -defined('MOODLE_INTERNAL') || die(); - class batch_set_workflow_state_viewed extends base { /** @var \assign */ protected $assign; @@ -45,8 +52,6 @@ class batch_set_workflow_state_viewed extends base { /** * Create instance of event. * - * @since Moodle 2.7 - * * @param \assign $assign * @return batch_set_workflow_state_viewed */ @@ -70,8 +75,6 @@ class batch_set_workflow_state_viewed extends base { * * NOTE: to be used from observers only. * - * @since Moodle 2.7 - * * @return \assign */ public function get_assign() { diff --git a/mod/assign/classes/event/course_module_instance_list_viewed.php b/mod/assign/classes/event/course_module_instance_list_viewed.php index 0509ef655a7..71bfc3def56 100644 --- a/mod/assign/classes/event/course_module_instance_list_viewed.php +++ b/mod/assign/classes/event/course_module_instance_list_viewed.php @@ -18,7 +18,6 @@ * The mod_assign instance list viewed event. * * @package mod_assign - * @since Moodle 2.7 * @copyright 2014 Mark Nelson * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ @@ -27,6 +26,14 @@ namespace mod_assign\event; defined('MOODLE_INTERNAL') || die(); +/** + * The mod_assign instance list viewed event. + * + * @package mod_assign + * @since Moodle 2.7 + * @copyright 2014 Mark Nelson + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ class course_module_instance_list_viewed extends \core\event\course_module_instance_list_viewed { /** * Create the event from course record. diff --git a/mod/assign/classes/event/feedback_updated.php b/mod/assign/classes/event/feedback_updated.php index e02c26e70d2..9b9c5ec6cbc 100644 --- a/mod/assign/classes/event/feedback_updated.php +++ b/mod/assign/classes/event/feedback_updated.php @@ -14,6 +14,18 @@ // You should have received a copy of the GNU General Public License // along with Moodle. If not, see . +/** + * The mod_assign feedback updated event. + * + * @package mod_assign + * @copyright 2014 Mark Nelson + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +namespace mod_assign\event; + +defined('MOODLE_INTERNAL') || die(); + /** * The mod_assign feedback updated event. * @@ -28,11 +40,6 @@ * @copyright 2014 Mark Nelson * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ - -namespace mod_assign\event; - -defined('MOODLE_INTERNAL') || die(); - class feedback_updated extends base { /** diff --git a/mod/assign/classes/event/feedback_viewed.php b/mod/assign/classes/event/feedback_viewed.php index a3c2d9b5105..e2143543181 100644 --- a/mod/assign/classes/event/feedback_viewed.php +++ b/mod/assign/classes/event/feedback_viewed.php @@ -14,6 +14,18 @@ // You should have received a copy of the GNU General Public License // along with Moodle. If not, see . +/** + * The mod_assign feedback viewed event. + * + * @package mod_assign + * @copyright 2014 Mark Nelson + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +namespace mod_assign\event; + +defined('MOODLE_INTERNAL') || die(); + /** * The mod_assign feedback viewed event. * @@ -28,11 +40,6 @@ * @copyright 2014 Mark Nelson * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ - -namespace mod_assign\event; - -defined('MOODLE_INTERNAL') || die(); - class feedback_viewed extends base { /** @var \assign */ protected $assign; @@ -47,8 +54,6 @@ class feedback_viewed extends base { /** * Create instance of event. * - * @since Moodle 2.7 - * * @param \assign $assign * @param \stdClass $grade * @return feedback_viewed @@ -76,8 +81,6 @@ class feedback_viewed extends base { * * NOTE: to be used from observers only. * - * @since Moodle 2.7 - * * @return \assign */ public function get_assign() { @@ -92,8 +95,6 @@ class feedback_viewed extends base { * * NOTE: to be used from observers only. * - * @since Moodle 2.7 - * * @return \stdClass */ public function get_grade() { diff --git a/mod/assign/classes/event/grading_form_viewed.php b/mod/assign/classes/event/grading_form_viewed.php index cd4aa19566f..b647f0ab594 100644 --- a/mod/assign/classes/event/grading_form_viewed.php +++ b/mod/assign/classes/event/grading_form_viewed.php @@ -14,6 +14,18 @@ // You should have received a copy of the GNU General Public License // along with Moodle. If not, see . +/** + * The mod_assign grading form viewed event. + * + * @package mod_assign + * @copyright 2014 Mark Nelson + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +namespace mod_assign\event; + +defined('MOODLE_INTERNAL') || die(); + /** * The mod_assign grading form viewed event. * @@ -28,11 +40,6 @@ * @copyright 2014 Mark Nelson * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ - -namespace mod_assign\event; - -defined('MOODLE_INTERNAL') || die(); - class grading_form_viewed extends base { /** @var \assign */ protected $assign; @@ -47,8 +54,6 @@ class grading_form_viewed extends base { /** * Create instance of event. * - * @since Moodle 2.7 - * * @param \assign $assign * @param \stdClass $user * @return grading_form_viewed @@ -75,8 +80,6 @@ class grading_form_viewed extends base { * * NOTE: to be used from observers only. * - * @since Moodle 2.7 - * * @return \assign */ public function get_assign() { @@ -91,8 +94,6 @@ class grading_form_viewed extends base { * * NOTE: to be used from observers only. * - * @since Moodle 2.7 - * * @return \stdClass */ public function get_user() { diff --git a/mod/assign/classes/event/grading_table_viewed.php b/mod/assign/classes/event/grading_table_viewed.php index ea2644114c8..a24b0e92de2 100644 --- a/mod/assign/classes/event/grading_table_viewed.php +++ b/mod/assign/classes/event/grading_table_viewed.php @@ -14,6 +14,18 @@ // You should have received a copy of the GNU General Public License // along with Moodle. If not, see . +/** + * The mod_assign grading table viewed event. + * + * @package mod_assign + * @copyright 2014 Mark Nelson + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +namespace mod_assign\event; + +defined('MOODLE_INTERNAL') || die(); + /** * The mod_assign grading table viewed event. * @@ -28,11 +40,6 @@ * @copyright 2014 Mark Nelson * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ - -namespace mod_assign\event; - -defined('MOODLE_INTERNAL') || die(); - class grading_table_viewed extends base { /** @var \assign */ protected $assign; @@ -45,8 +52,6 @@ class grading_table_viewed extends base { /** * Create instance of event. * - * @since Moodle 2.7 - * * @param \assign $assign * @return grading_table_viewed */ @@ -70,8 +75,6 @@ class grading_table_viewed extends base { * * NOTE: to be used from observers only. * - * @since Moodle 2.7 - * * @return \assign */ public function get_assign() { diff --git a/mod/assign/classes/event/reveal_identities_confirmation_page_viewed.php b/mod/assign/classes/event/reveal_identities_confirmation_page_viewed.php index a6a07dc4db3..595ab6156e9 100644 --- a/mod/assign/classes/event/reveal_identities_confirmation_page_viewed.php +++ b/mod/assign/classes/event/reveal_identities_confirmation_page_viewed.php @@ -14,6 +14,18 @@ // You should have received a copy of the GNU General Public License // along with Moodle. If not, see . +/** + * The mod_assign reveal identities confirmation page viewed event. + * + * @package mod_assign + * @copyright 2014 Mark Nelson + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +namespace mod_assign\event; + +defined('MOODLE_INTERNAL') || die(); + /** * The mod_assign reveal identities confirmation page viewed event. * @@ -28,11 +40,6 @@ * @copyright 2014 Mark Nelson * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ - -namespace mod_assign\event; - -defined('MOODLE_INTERNAL') || die(); - class reveal_identities_confirmation_page_viewed extends base { /** @var \assign */ protected $assign; @@ -45,8 +52,6 @@ class reveal_identities_confirmation_page_viewed extends base { /** * Create instance of event. * - * @since Moodle 2.7 - * * @param \assign $assign * @return reveal_identities_confirmation_page_viewed */ @@ -70,8 +75,6 @@ class reveal_identities_confirmation_page_viewed extends base { * * NOTE: to be used from observers only. * - * @since Moodle 2.7 - * * @return \assign */ public function get_assign() { diff --git a/mod/assign/classes/event/submission_confirmation_form_viewed.php b/mod/assign/classes/event/submission_confirmation_form_viewed.php index 6e21faa78e2..6747253e807 100644 --- a/mod/assign/classes/event/submission_confirmation_form_viewed.php +++ b/mod/assign/classes/event/submission_confirmation_form_viewed.php @@ -14,6 +14,18 @@ // You should have received a copy of the GNU General Public License // along with Moodle. If not, see . +/** + * The mod_assign submission form viewed event. + * + * @package mod_assign + * @copyright 2014 Mark Nelson + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +namespace mod_assign\event; + +defined('MOODLE_INTERNAL') || die(); + /** * The mod_assign submission form viewed event. * @@ -28,11 +40,6 @@ * @copyright 2014 Mark Nelson * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ - -namespace mod_assign\event; - -defined('MOODLE_INTERNAL') || die(); - class submission_confirmation_form_viewed extends base { /** @var \assign */ protected $assign; @@ -45,8 +52,6 @@ class submission_confirmation_form_viewed extends base { /** * Create instance of event. * - * @since Moodle 2.7 - * * @param \assign $assign * @return submission_confirmation_form_viewed */ @@ -70,8 +75,6 @@ class submission_confirmation_form_viewed extends base { * * NOTE: to be used from observers only. * - * @since Moodle 2.7 - * * @return \assign */ public function get_assign() { diff --git a/mod/assign/classes/event/submission_form_viewed.php b/mod/assign/classes/event/submission_form_viewed.php index 3596dc6f1c6..cc650fd97f6 100644 --- a/mod/assign/classes/event/submission_form_viewed.php +++ b/mod/assign/classes/event/submission_form_viewed.php @@ -14,6 +14,18 @@ // You should have received a copy of the GNU General Public License // along with Moodle. If not, see . +/** + * The mod_assign submission form viewed event. + * + * @package mod_assign + * @copyright 2014 Mark Nelson + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +namespace mod_assign\event; + +defined('MOODLE_INTERNAL') || die(); + /** * The mod_assign submission form viewed event. * @@ -28,11 +40,6 @@ * @copyright 2014 Mark Nelson * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ - -namespace mod_assign\event; - -defined('MOODLE_INTERNAL') || die(); - class submission_form_viewed extends base { /** @var \assign */ protected $assign; @@ -47,8 +54,6 @@ class submission_form_viewed extends base { /** * Create instance of event. * - * @since Moodle 2.7 - * * @param \assign $assign * @param \stdClass $user * @return submission_form_viewed @@ -75,8 +80,6 @@ class submission_form_viewed extends base { * * NOTE: to be used from observers only. * - * @since Moodle 2.7 - * * @return \assign */ public function get_assign() { @@ -91,8 +94,6 @@ class submission_form_viewed extends base { * * NOTE: to be used from observers only. * - * @since Moodle 2.7 - * * @return \stdClass */ public function get_user() { diff --git a/mod/assign/classes/event/submission_status_viewed.php b/mod/assign/classes/event/submission_status_viewed.php index 20e34cc155f..de90b8fdbd4 100644 --- a/mod/assign/classes/event/submission_status_viewed.php +++ b/mod/assign/classes/event/submission_status_viewed.php @@ -14,6 +14,18 @@ // You should have received a copy of the GNU General Public License // along with Moodle. If not, see . +/** + * The mod_assign submission status viewed event. + * + * @package mod_assign + * @copyright 2014 Mark Nelson + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +namespace mod_assign\event; + +defined('MOODLE_INTERNAL') || die(); + /** * The mod_assign submission status viewed event. * @@ -28,11 +40,6 @@ * @copyright 2014 Mark Nelson * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ - -namespace mod_assign\event; - -defined('MOODLE_INTERNAL') || die(); - class submission_status_viewed extends base { /** @var \assign */ protected $assign; @@ -45,8 +52,6 @@ class submission_status_viewed extends base { /** * Create instance of event. * - * @since Moodle 2.7 - * * @param \assign $assign * @return submission_status_viewed */ @@ -70,8 +75,6 @@ class submission_status_viewed extends base { * * NOTE: to be used from observers only. * - * @since Moodle 2.7 - * * @return \assign */ public function get_assign() { diff --git a/mod/assign/classes/event/submission_viewed.php b/mod/assign/classes/event/submission_viewed.php index 4aec8218e34..24f5b29b1c8 100644 --- a/mod/assign/classes/event/submission_viewed.php +++ b/mod/assign/classes/event/submission_viewed.php @@ -14,6 +14,18 @@ // You should have received a copy of the GNU General Public License // along with Moodle. If not, see . +/** + * The mod_assign submission viewed event. + * + * @package mod_assign + * @copyright 2014 Mark Nelson + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +namespace mod_assign\event; + +defined('MOODLE_INTERNAL') || die(); + /** * The mod_assign submission viewed event. * @@ -28,11 +40,6 @@ * @copyright 2014 Mark Nelson * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ - -namespace mod_assign\event; - -defined('MOODLE_INTERNAL') || die(); - class submission_viewed extends base { /** @var \assign */ protected $assign; @@ -47,8 +54,6 @@ class submission_viewed extends base { /** * Create instance of event. * - * @since Moodle 2.7 - * * @param \assign $assign * @param \stdClass $submission * @return submission_viewed @@ -76,8 +81,6 @@ class submission_viewed extends base { * * NOTE: to be used from observers only. * - * @since Moodle 2.7 - * * @return \assign */ public function get_assign() { @@ -92,8 +95,6 @@ class submission_viewed extends base { * * NOTE: to be used from observers only. * - * @since Moodle 2.7 - * * @return \stdClass */ public function get_submission() {