MDL-30995 completion: updating PHPdocs as suggested by little smurfs
authorAnkit Agarwal <ankit@moodle.com>
Wed, 14 Mar 2012 06:39:36 +0000 (14:39 +0800)
committerAnkit Agarwal <ankit@moodle.com>
Wed, 14 Mar 2012 06:39:36 +0000 (14:39 +0800)
lib/completion/completion_completion.php
lib/completion/completion_criteria_completion.php
lib/completion/completion_criteria_role.php
lib/completion/cron.php
lib/completion/data_object.php
lib/completionlib.php

index f744a97..2b5d8bf 100644 (file)
@@ -57,16 +57,16 @@ class completion_completion extends data_object {
     /* @var int Timestamp the interested parties were notified of this user's completion. */
     public $timenotified;
 
-    /* @var int Time of course enrolment {@see completion_completion::mark_enrolled()} */
+    /* @var int Time of course enrolment {@link completion_completion::mark_enrolled()} */
     public $timeenrolled;
 
     /**
-     * Time the user started their course completion {@see completion_completion::mark_inprogress()}
+     * Time the user started their course completion {@link completion_completion::mark_inprogress()}
      * @var int
      */
     public $timestarted;
 
-    /* @var int Timestamp of course completion {@see completion_completion::mark_complete()} */
+    /* @var int Timestamp of course completion {@link completion_completion::mark_complete()} */
     public $timecompleted;
 
     /* @var int Flag to trigger cron aggregation (timestamp) */
index 10e54d0..f4d700d 100644 (file)
@@ -65,7 +65,7 @@ class completion_criteria_completion extends data_object {
     /* @var int Timestamp of user unenrolment (if completing a unenrol criteria) */
     public $unenroled;
 
-    /* @var int Timestamp of course criteria completion {@see completion_criteria_completion::mark_complete()} */
+    /* @var int Timestamp of course criteria completion {@link completion_criteria_completion::mark_complete()} */
     public $timecompleted;
 
     /* @var completion_criterria Associated criteria object */
@@ -141,8 +141,7 @@ class completion_criteria_completion extends data_object {
      */
     public function get_criteria() {
 
-        if (!$this->_criteria) 
-        {
+        if (!$this->_criteria) {
             global $DB;
 
             $params = array(
@@ -158,7 +157,7 @@ class completion_criteria_completion extends data_object {
     }
 
     /**
-     * Return criteria status text for display in reports {@see completion_criteria::get_status()}
+     * Return criteria status text for display in reports {@link completion_criteria::get_status()}
      *
      * @return string
      */
index 0eeb462..5b2d051 100644 (file)
@@ -105,8 +105,7 @@ class completion_criteria_role extends completion_criteria {
      */
     public function review($completion, $mark = true, $is_complete = false)  {
         // If we are marking this as complete
-        if ($is_complete && $mark) 
-        {
+        if ($is_complete && $mark) {
             $completion->completedself = 1;
             $completion->mark_complete();
 
index 1cd9ec2..be480d4 100644 (file)
@@ -25,7 +25,7 @@
  */
 
 defined('MOODLE_INTERNAL') || die();
-require_once $CFG->libdir.'/completionlib.php';
+require_once($CFG->libdir.'/completionlib.php');
 
 /**
  * Update user's course completion statuses
index d0af398..01345ee 100644 (file)
@@ -60,7 +60,7 @@ abstract class data_object {
      * @param bool $fetch Whether to fetch corresponding row from DB or not,
      *        optional fields might not be defined if false used
      */
-    public function __construct($params = NULL, $fetch = true) {
+    public function __construct($params = null, $fetch = true) {
         if (!empty($params) and (is_array($params) or is_object($params))) {
             if ($fetch) {
                 if ($data = $this->fetch($params)) {
@@ -337,5 +337,6 @@ abstract class data_object {
      *
      * @param bool $deleted Set this to true if it has been deleted.
      */
-    public function notify_changed($deleted) {}
+    public function notify_changed($deleted) {
+    }
 }
\ No newline at end of file
index c0a23c0..a5086f8 100644 (file)
@@ -165,7 +165,7 @@ class completion_info {
     /* @var int Course id */
     public $course_id;
 
-    /* @var array Completion criteria {@see completion_info::get_criteria()}  */
+    /* @var array Completion criteria {@link completion_info::get_criteria()}  */
     private $criteria;
 
     /**