L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL-41101 tidy up the phpdocs in new assign events

Browse Source
This commit is contained in:
Petr Škoda
2014-04-17 09:51:12 +08:00
committed by Petr Skoda
parent 1b90858f23
commit 0e5deb2018
12 changed files with 140 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files
mod/assign/classes/event/batch_set_marker_allocation_viewed.php
+12 -9
View File
@@ -14,6 +14,18 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* The mod_assign batch set marker allocation viewed event.
*
* @package mod_assign
* @copyright 2014 Mark Nelson <[email protected]>
* @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 <[email protected]>
* @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() {
mod/assign/classes/event/batch_set_workflow_state_viewed.php
+12 -9
View File
@@ -14,6 +14,18 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* The mod_assign assignment batch set workflow stated viewed event.
*
* @package mod_assign
* @copyright 2014 Mark Nelson <[email protected]>
* @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 <[email protected]>
* @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() {
mod/assign/classes/event/course_module_instance_list_viewed.php
+8 -1
View File
@@ -18,7 +18,6 @@
* The mod_assign instance list viewed event.
*
* @package mod_assign
* @since Moodle 2.7
* @copyright 2014 Mark Nelson <[email protected]>
* @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 <[email protected]>
* @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.
mod/assign/classes/event/feedback_updated.php
+12 -5
View File
@@ -14,6 +14,18 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* The mod_assign feedback updated event.
*
* @package mod_assign
* @copyright 2014 Mark Nelson <[email protected]>
* @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 <[email protected]>
* @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 {
/**
mod/assign/classes/event/feedback_viewed.php
+12 -11
View File
@@ -14,6 +14,18 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* The mod_assign feedback viewed event.
*
* @package mod_assign
* @copyright 2014 Mark Nelson <[email protected]>
* @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 <[email protected]>
* @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() {
mod/assign/classes/event/grading_form_viewed.php
+12 -11
View File
@@ -14,6 +14,18 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* The mod_assign grading form viewed event.
*
* @package mod_assign
* @copyright 2014 Mark Nelson <[email protected]>
* @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 <[email protected]>
* @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() {
mod/assign/classes/event/grading_table_viewed.php
+12 -9
View File
@@ -14,6 +14,18 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* The mod_assign grading table viewed event.
*
* @package mod_assign
* @copyright 2014 Mark Nelson <[email protected]>
* @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 <[email protected]>
* @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() {
mod/assign/classes/event/reveal_identities_confirmation_page_viewed.php
+12 -9
View File
@@ -14,6 +14,18 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* The mod_assign reveal identities confirmation page viewed event.
*
* @package mod_assign
* @copyright 2014 Mark Nelson <[email protected]>
* @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 <[email protected]>
* @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() {
mod/assign/classes/event/submission_confirmation_form_viewed.php
+12 -9
View File
@@ -14,6 +14,18 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* The mod_assign submission form viewed event.
*
* @package mod_assign
* @copyright 2014 Mark Nelson <[email protected]>
* @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 <[email protected]>
* @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() {
mod/assign/classes/event/submission_form_viewed.php
+12 -11
View File
@@ -14,6 +14,18 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* The mod_assign submission form viewed event.
*
* @package mod_assign
* @copyright 2014 Mark Nelson <[email protected]>
* @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 <[email protected]>
* @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() {
mod/assign/classes/event/submission_status_viewed.php
+12 -9
View File
@@ -14,6 +14,18 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* The mod_assign submission status viewed event.
*
* @package mod_assign
* @copyright 2014 Mark Nelson <[email protected]>
* @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 <[email protected]>
* @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() {
mod/assign/classes/event/submission_viewed.php
+12 -11
View File
@@ -14,6 +14,18 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* The mod_assign submission viewed event.
*
* @package mod_assign
* @copyright 2014 Mark Nelson <[email protected]>
* @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 <[email protected]>
* @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() {