CRM/Core/BAO/Job.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id: $
  33  *
  34  */
  35
  36 /**
  37  * This class contains scheduled jobs related functions.
  38  */
  39 class CRM_Core_BAO_Job extends CRM_Core_DAO_Job {
  40
  41   /**
  42    * Class constructor
  43    */
  44   public function __construct() {
  45     parent::__construct();
  46   }
  47
  48   /**
  49    * Add the payment-processor type in the db
  50    *
  51    * @param array $params
  52    *   An assoc array of name/value pairs.
  53    *
  54    * @return CRM_Financial_DAO_PaymentProcessorType
  55    * @static
  56    */
  57   public static function create($params) {
  58     $job = new CRM_Core_DAO_Job();
  59     $job->copyValues($params);
  60     return $job->save();
  61   }
  62
  63   /**
  64    * Takes a bunch of params that are needed to match certain criteria and
  65    * retrieves the relevant objects. It also stores all the retrieved
  66    * values in the default array
  67    *
  68    * @param array $params
  69    *   (reference ) an assoc array of name/value pairs.
  70    * @param array $defaults
  71    *   (reference ) an assoc array to hold the flattened values.
  72    *
  73    * @return CRM_Core_DAO_Job|null
  74    *   object on success, null otherwise
  75    * @static
  76    */
  77   public static function retrieve(&$params, &$defaults) {
  78     $job = new CRM_Core_DAO_Job();
  79     $job->copyValues($params);
  80     if ($job->find(TRUE)) {
  81       CRM_Core_DAO::storeValues($job, $defaults);
  82       return $job;
  83     }
  84     return NULL;
  85   }
  86
  87   /**
  88    * Update the is_active flag in the db
  89    *
  90    * @param int $id
  91    *   Id of the database record.
  92    * @param bool $is_active
  93    *   Value we want to set the is_active field.
  94    *
  95    * @return Object
  96    *   DAO object on sucess, null otherwise
  97    *
  98    * @static
  99    */
 100   public static function setIsActive($id, $is_active) {
 101     return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_Job', $id, 'is_active', $is_active);
 102   }
 103
 104   /**
 105    * Function  to delete scheduled job
 106    *
 107    * @param $jobID
 108    *   ID of the job to be deleted.
 109    *
 110    * @return bool|null
 111    * @static
 112    */
 113   public static function del($jobID) {
 114     if (!$jobID) {
 115       CRM_Core_Error::fatal(ts('Invalid value passed to delete function.'));
 116     }
 117
 118     $dao = new CRM_Core_DAO_Job();
 119     $dao->id = $jobID;
 120     if (!$dao->find(TRUE)) {
 121       return NULL;
 122     }
 123
 124     if ($dao->delete()) {
 125       return TRUE;
 126     }
 127   }
 128
 129   /**
 130    * Trim job table on a regular basis to keep it at a good size
 131    *
 132    * CRM-10513
 133    */
 134   public static function cleanup($maxEntriesToKeep = 1000, $minDaysToKeep = 30) {
 135     // Prevent the job log from getting too big
 136     // For now, keep last minDays days and at least maxEntries records
 137     $query = 'SELECT COUNT(*) FROM civicrm_job_log';
 138     $count = CRM_Core_DAO::singleValueQuery($query);
 139
 140     if ($count <= $maxEntriesToKeep) {
 141       return;
 142     }
 143
 144     $count = $count - $maxEntriesToKeep;
 145
 146     $query = "DELETE FROM civicrm_job_log WHERE run_time < SUBDATE(NOW(), $minDaysToKeep) LIMIT $count";
 147     CRM_Core_DAO::executeQuery($query);
 148   }
 149
 150 }