<?php
-// $Id$
-
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
*/
/**
- * new version of civicrm APIs. See blog post at
- * http://civicrm.org/node/131
+ * This api is used for working with scheduled "cron" jobs.
*
* @package CiviCRM_APIv3
- * @subpackage API_Job
- * @copyright CiviCRM LLC (c) 2004-2014
- * $Id: Contact.php 30879 2010-11-22 15:45:55Z shot $
*/
/**
* The metadata is used for setting defaults, documentation & validation.
*
* @param array $params
- * Array or parameters determined by getfields.
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_job_create_spec(&$params) {
$params['run_frequency']['api.required'] = 1;
$facility->execute(FALSE);
// Always creates success - results are handled elsewhere.
- return civicrm_api3_create_success(1, $params);
+ return civicrm_api3_create_success(1, $params, 'Job');
}
/**
* Adjust Metadata for Execute action.
*
* @param array $params
- * Array or parameters determined by getfields.
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_job_execute_spec(&$params) {
}
* @param array $params
*/
function _civicrm_api3_job_geocode_spec(&$params) {
- $params['start'] = array('title' => 'Start Date');
- $params['end'] = array('title' => 'End Date');
- $params['geocoding'] = array('title' => 'Geocode address?');
- $params['parse'] = array('title' => 'Parse street address?');
- $params['throttle'] = array('title' => 'Throttle? if enabled, geo-codes at a slow rate');
+ $params['start'] = array(
+ 'title' => 'Start Date',
+ 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
+ );
+ $params['end'] = array(
+ 'title' => 'End Date',
+ 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
+ );
+ $params['geocoding'] = array(
+ 'title' => 'Geocode address?',
+ 'type' => CRM_Utils_Type::T_BOOLEAN,
+ );
+ $params['parse'] = array(
+ 'title' => 'Parse street address?',
+ 'type' => CRM_Utils_Type::T_BOOLEAN,
+ );
+ $params['throttle'] = array(
+ 'title' => 'Throttle?',
+ 'description' => 'If enabled, geo-codes at a slow rate',
+ 'type' => CRM_Utils_Type::T_BOOLEAN,
+ );
}
/**
* The metadata is used for setting defaults, documentation & validation.
*
* @param array $params
- * Array or parameters determined by getfields.
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_job_send_reminder(&$params) {
//@todo this function will now take all fields in action_schedule as params
* The metadata is used for setting defaults, documentation & validation.
*
* @param array $params
- * Array or parameters determined by getfields.
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_job_update_greeting_spec(&$params) {
$params['ct'] = array(
}
else {
$values = array();
- return civicrm_api3_create_success($values, $params, 'mailing', 'process');
+ return civicrm_api3_create_success($values, $params, 'Job', 'process_mailing');
}
}
}
else {
$values = array();
- return civicrm_api3_create_success($values, $params, 'mailing', 'process');
+ return civicrm_api3_create_success($values, $params, 'Job', 'process_sms');
}
}
// FIXME: processBounces doesn't return true/false on success/failure
$values = array();
- return civicrm_api3_create_success($values, $params, 'mailing', 'bounces');
+ return civicrm_api3_create_success($values, $params, 'Job', 'fetch_bounces');
}
/**
CRM_Utils_Mail_EmailProcessor::processActivities();
$values = array();
$lock->release();
- return civicrm_api3_create_success($values, $params, 'mailing', 'activities');
+ return civicrm_api3_create_success($values, $params, 'Job', 'fetch_activities');
}
catch (Exception $e) {
$lock->release();
$lock->release();
if ($result['is_error'] == 0) {
- return civicrm_api3_create_success($result['messages'], $params);
+ return civicrm_api3_create_success($result['messages'], $params, 'Job', 'process_membership');
}
else {
return civicrm_api3_create_error($result['messages']);
if (!$result) {
throw new API_Exception('Failed to disable all expired relationships.');
}
- return civicrm_api3_create_success(1, $params);
+ return civicrm_api3_create_success(1, $params, 'Job', 'disable_expired_relationships');
}
/**