<?php
-// $Id$
-
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
- * 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 $
- *
*/
/**
- * Adjust metadata for "Create" action
+ * Adjust metadata for "Create" action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
*
- * 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;
}
/**
- * create scheduled job
+ * Create scheduled job.
*
* @param array $params
* Associative array of property name/value pairs to insert in new job.
*
* @return array
- *
- * {@getfields Job_create}
*/
function civicrm_api3_job_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
- * Retrieve one or more job
+ * Retrieve one or more job.
*
* @param array $params
* input parameters
- * @return array
*
- * {@getfields email_get}
+ * @return array
*/
function civicrm_api3_job_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
- * Delete a job
+ * Delete a job.
*
* @param array $params
- *
- * {@getfields Job_delete}
*/
function civicrm_api3_job_delete($params) {
_civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
- * Dumb wrapper to execute scheduled jobs. Always creates success - errors
- * and results are handled in the job log.
+ * Dumb wrapper to execute scheduled jobs.
+ *
+ * Always creates success - errors and results are handled in the job log.
*
* @param array $params
* input parameters (unused).
* API Result Array
*/
function civicrm_api3_job_execute($params) {
- // @noinspection PhpUnusedParameterInspection
$facility = new CRM_Core_JobManager();
$facility->execute(FALSE);
- // always creates success - results are handled elsewhere
- return civicrm_api3_create_success();
+ // Always creates success - results are handled elsewhere.
+ return civicrm_api3_create_success(1, $params, 'Job');
}
/**
- * Adjust Metadata for Execute action
+ * 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) {
}
/**
- * Geocode group of contacts based on given params
+ * Geocode group of contacts based on given params.
*
* @param array $params
* input parameters.
}
/**
- * First check on Code documentation
+ * First check on Code documentation.
*
* @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,
+ );
}
/**
- * Send the scheduled reminders for all contacts (either for activities or events)
+ * Send the scheduled reminders for all contacts (either for activities or events).
*
* @param array $params
* (reference ) input parameters.
}
}
/**
- * Adjust metadata for "send_reminder" action
+ * Adjust metadata for "send_reminder" action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
*
- * 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
);
}
/**
- * Execute a specific report instance and send the output via email
+ * Execute a specific report instance and send the output via email.
*
* @param array $params
* (reference ) input parameters.
}
/**
- *
* This method allows to update Email Greetings, Postal Greetings and Addressee for a specific contact type.
+ *
* IMPORTANT: You must first create valid option value before using via admin interface.
* Check option lists for Email Greetings, Postal Greetings and Addressee
*
- * id - Integer - greetings option group
+ * @todo - is this here by mistake or should it be added to _spec function :id - Integer - greetings option group.
*
* @param array $params
*
}
/**
- * Adjust Metadata for Get action
+ * Adjust Metadata for Get action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
*
- * 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(
}
/**
- * Mass update pledge statuses
+ * Mass update pledge statuses.
*
* @param array $params
+ *
* @return array
*/
function civicrm_api3_job_process_pledge($params) {
}
/**
- * Process mail queue
+ * Process mail queue.
*
* @param array $params
*
}
else {
$values = array();
- return civicrm_api3_create_success($values, $params, 'mailing', 'process');
+ return civicrm_api3_create_success($values, $params, 'Job', 'process_mailing');
}
}
/**
- * Process sms queue
+ * Process sms queue.
*
* @param array $params
*
}
else {
$values = array();
- return civicrm_api3_create_success($values, $params, 'mailing', 'process');
+ return civicrm_api3_create_success($values, $params, 'Job', 'process_sms');
}
}
/**
- * Job to get mail responses from civiMailing
+ * Job to get mail responses from civiMailing.
*
* @param array $params
*
// 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');
}
/**
- * Job to get mail and create activities
+ * Job to get mail and create activities.
*
* @param array $params
*
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();
}
/**
- * Process participant statuses
+ * Process participant statuses.
*
* @param array $params
- * (reference ) input parameters.
+ * Input parameters.
*
* @return array
* array of properties, if error an array with an error id and error message
/**
- * This api checks and updates the status of all membership records for a given domain using the calc_membership_status and
- * update_contact_membership APIs.
+ * This api checks and updates the status of all membership records for a given domain.
+ *
+ * The function uses the calc_membership_status and update_contact_membership APIs.
*
* IMPORTANT:
* Sending renewal reminders has been migrated from this job to the Scheduled Reminders function as of 4.3.
$lock->release();
if ($result['is_error'] == 0) {
- return civicrm_api3_create_success($result['messages']);
+ return civicrm_api3_create_success($result['messages'], $params, 'Job', 'process_membership');
}
else {
return civicrm_api3_create_error($result['messages']);
*
* @return array
* API Result Array
- *
*/
function civicrm_api3_job_process_batch_merge($params) {
$rgid = CRM_Utils_Array::value('rgid', $params);
}
/**
+ * Metadata for batch merge function.
+ *
* @param $params
*/
function _civicrm_api3_job_process_batch_merge_spec(&$params) {
}
/**
- * Runs handlePaymentCron method in the specified payment processor
+ * Runs handlePaymentCron method in the specified payment processor.
*
* @param array $params
* Input parameters.
*
- * Expected @params array keys are:
+ * Expected @params array keys are: INCORRECTLY DOCUMENTED AND SHOULD BE IN THE _spec function
+ * for retrieval via getfields.
* {string 'processor_name' - the name of the payment processor, eg: Sagepay}
- *
*/
function civicrm_api3_job_run_payment_cron($params) {
}
/**
- * This api cleans up all the old session entries and temp tables. We recommend that sites run this on an hourly basis
+ * This api cleans up all the old session entries and temp tables.
+ *
+ * We recommend that sites run this on an hourly basis.
*
* @param array $params
* Sends in various config parameters to decide what needs to be cleaned.
/**
* Set expired relationships to disabled.
- * @param $params
+ *
+ * @param array $params
+ *
* @return array
* @throws \API_Exception
*/
function civicrm_api3_job_disable_expired_relationships($params) {
- /** @noinspection PhpUnusedParameterInspection */
$result = CRM_Contact_BAO_Relationship::disableExpiredRelationships();
if (!$result) {
throw new API_Exception('Failed to disable all expired relationships.');
}
- return civicrm_api3_create_success();
+ return civicrm_api3_create_success(1, $params, 'Job', 'disable_expired_relationships');
}
/**
- * This api reloads all the smart groups. If the org has a large number of smart groups
- * it is recommended that they use the limit clause to limit the number of smart groups
- * evaluated on a per job basis. Might also help to increase the smartGroupCacheTimeout
- * and use the cache
+ * This api reloads all the smart groups.
+ *
+ * If the org has a large number of smart groups it is recommended that they use the limit clause
+ * to limit the number of smart groups evaluated on a per job basis.
+ *
+ * Might also help to increase the smartGroupCacheTimeout and use the cache.
*
* @param array $params
+ *
* @return array
* @throws \API_Exception
*/
projects / civicrm-core.git / blobdiff