+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| 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: $
*
*/
class CRM_Core_BAO_Job extends CRM_Core_DAO_Job {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
* An assoc array of name/value pairs.
*
* @return CRM_Financial_DAO_PaymentProcessorType
- * @static
*/
public static function create($params) {
$job = new CRM_Core_DAO_Job();
}
/**
- * 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.
*
- * @return CRM_Core_DAO_Job object on success, null otherwise
- * @static
+ * @return CRM_Core_DAO_Job|null
+ * object on success, null otherwise
*/
public static function retrieve(&$params, &$defaults) {
$job = new 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 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
*
- * @static
*/
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.
*
* @return bool|null
- * @static
*/
public static function del($jobID) {
if (!$jobID) {
}
/**
- * 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
*/