Merge pull request #4820 from kurund/CRM-15705
[civicrm-core.git] / CRM / Core / ScheduledJob.php
index 149bd126e100763a38858eccda52fff097c45103..96a84f2e7b60a511056b5a1d4a0868c4fbf71861 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -44,14 +44,9 @@ class CRM_Core_ScheduledJob {
 
   var $remarks = array();
 
-  /*
-     * Class constructor
-     *
-     * @param string $namespace namespace prefix for component's files
-     * @access public
-     *
-     */
-
+  /**
+   * @param array $params
+   */
   public function __construct($params) {
     foreach ($params as $name => $param) {
       $this->$name = $param;
@@ -81,6 +76,9 @@ class CRM_Core_ScheduledJob {
     }
   }
 
+  /**
+   * @param null $date
+   */
   public function saveLastRun($date = NULL) {
     $dao           = new CRM_Core_DAO_Job();
     $dao->id       = $this->id;
@@ -88,6 +86,9 @@ class CRM_Core_ScheduledJob {
     $dao->save();
   }
 
+  /**
+   * @return bool
+   */
   public function needsRunning() {
     // run if it was never run
     if (empty($this->last_run)) {
@@ -121,4 +122,3 @@ class CRM_Core_ScheduledJob {
 
   public function __destruct() {}
 }
-