X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FActionSchedule.php;h=8486c51bafcb7e1fd5de3ee0d040d5b4b99e3416;hb=244bbdd85415317b95f70bf85a3ecb036c4fe840;hp=ed0c42605cede441acaa9ddf4c7e50cef18d5ac1;hpb=1e66775e6f88ac33d643ca2d68577ab01dd41dd5;p=civicrm-core.git diff --git a/api/v3/ActionSchedule.php b/api/v3/ActionSchedule.php index ed0c42605c..8486c51baf 100644 --- a/api/v3/ActionSchedule.php +++ b/api/v3/ActionSchedule.php @@ -26,28 +26,25 @@ */ /** - * File for the CiviCRM APIv3 for Scheduled Reminders + * This api exposes CiviCRM Scheduled Reminders. * * @package CiviCRM_APIv3 - * @subpackage API_ActionSchedule - * - * @copyright CiviCRM LLC (c) 2004-2014 */ /** - * Get CiviCRM Action Schedule details. + * Get CiviCRM ActionSchedule details. * * @param array $params * * @return array */ function civicrm_api3_action_schedule_get($params) { - return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'action_schedule'); + return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'ActionSchedule'); } /** - * Create a new Action Schedule. + * Create a new ActionSchedule. * * @param array $params * @@ -58,7 +55,7 @@ function civicrm_api3_action_schedule_create($params) { if (!array_key_exists('name', $params) && !array_key_exists('id', $params)) { $params['name'] = CRM_Utils_String::munge($params['title']); } - return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'action_schedule'); + return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'ActionSchedule'); } /** @@ -67,7 +64,7 @@ function civicrm_api3_action_schedule_create($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_action_schedule_create_spec(&$params) { $params['title']['api.required'] = TRUE; @@ -76,11 +73,10 @@ function _civicrm_api3_action_schedule_create_spec(&$params) { } /** - * Delete an existing action_schedule. + * Delete an existing ActionSchedule. * * @param array $params - * Array containing id of the action_schedule. - * to be deleted + * Array containing id of the action_schedule to be deleted. * * @return array * API result array