codespell: CRM/*

[civicrm-core.git] / CRM / Core / BAO / Job.php

diff --git a/CRM/Core/BAO/Job.php b/CRM/Core/BAO/Job.php
index bfdc8dc728eb69da0f036567961512171ec98ad1..1283ca2f1c1c29d86d52470069b84549904d8e18 100644 (file)
--- a/CRM/Core/BAO/Job.php
+++ b/CRM/Core/BAO/Job.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,12 +23,12 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
  * $Id: $
  *
  */
@@ -39,40 +39,40 @@
 class CRM_Core_BAO_Job extends CRM_Core_DAO_Job {
 
   /**
-   * Class constructor
+   * Class constructor.
    */
-  function __construct() {
+  public function __construct() {
     parent::__construct();
   }
 
   /**
    * Add the payment-processor type in the db
    *
-   * @param array $params an assoc array of name/value pairs
+   * @param array $params
+   *   An assoc array of name/value pairs.
    *
    * @return CRM_Financial_DAO_PaymentProcessorType
-   * @access public
-   * @static
    */
-  static function create($params) {
+  public static function create($params) {
     $job = new CRM_Core_DAO_Job();
     $job->copyValues($params);
     return $job->save();
   }
 
   /**
-   * Takes a bunch of params that are needed to match certain criteria and
-   * retrieves the relevant objects. It also stores all the retrieved
-   * values in the default array
+   * Retrieve DB object based on input parameters.
+   *
+   * It also stores all the retrieved values in the default array.
    *
-   * @param array $params   (reference ) an assoc array of name/value pairs
-   * @param array $defaults (reference ) an assoc array to hold the flattened values
+   * @param array $params
+   *   (reference ) an assoc array of name/value pairs.
+   * @param array $defaults
+   *   (reference ) an assoc array to hold the flattened values.
    *
-   * @return CRM_Core_DAO_Job object on success, null otherwise
-   * @access public
-   * @static
+   * @return CRM_Core_DAO_Job|null
+   *   object on success, null otherwise
    */
-  static function retrieve(&$params, &$defaults) {
+  public static function retrieve(&$params, &$defaults) {
     $job = new CRM_Core_DAO_Job();
     $job->copyValues($params);
     if ($job->find(TRUE)) {
@@ -83,30 +83,30 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job {
   }
 
   /**
-   * Update the is_active flag in the db
+   * Update the is_active flag in the db.
    *
-   * @param int      $id        id of the database record
-   * @param boolean  $is_active value we want to set the is_active field
+   * @param int $id
+   *   Id of the database record.
+   * @param bool $is_active
+   *   Value we want to set the is_active field.
    *
-   * @return Object             DAO object on sucess, null otherwise
+   * @return Object
+   *   DAO object on success, null otherwise
    *
-   * @access public
-   * @static
    */
-  static function setIsActive($id, $is_active) {
+  public static function setIsActive($id, $is_active) {
     return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_Job', $id, 'is_active', $is_active);
   }
 
   /**
-   * Function  to delete scheduled job
+   * Function  to delete scheduled job.
    *
-   * @param $jobID ID of the job to be deleted.
+   * @param $jobID
+   *   ID of the job to be deleted.
    *
    * @return bool|null
-   * @access public
-   * @static
    */
-  static function del($jobID) {
+  public static function del($jobID) {
     if (!$jobID) {
       CRM_Core_Error::fatal(ts('Invalid value passed to delete function.'));
     }
@@ -123,17 +123,17 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job {
   }
 
   /**
-   * Trim job table on a regular basis to keep it at a good size
+   * Trim job table on a regular basis to keep it at a good size.
    *
    * CRM-10513
    */
-  static function cleanup($maxEntriesToKeep = 1000, $minDaysToKeep = 30) {
+  public static function cleanup($maxEntriesToKeep = 1000, $minDaysToKeep = 30) {
     // Prevent the job log from getting too big
     // For now, keep last minDays days and at least maxEntries records
     $query = 'SELECT COUNT(*) FROM civicrm_job_log';
     $count = CRM_Core_DAO::singleValueQuery($query);
 
-    if ( $count <= $maxEntriesToKeep) {
+    if ($count <= $maxEntriesToKeep) {
       return;
     }