X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FActionSchedule.php;h=8486c51bafcb7e1fd5de3ee0d040d5b4b99e3416;hb=244bbdd85415317b95f70bf85a3ecb036c4fe840;hp=721000cc23788bda62178ecb7cc270bd7a368ed5;hpb=bfc6355af6949ca1e4a7c39d0f54f0ec70b641bf;p=civicrm-core.git

diff --git a/api/v3/ActionSchedule.php b/api/v3/ActionSchedule.php
index 721000cc23..8486c51baf 100644
--- a/api/v3/ActionSchedule.php
+++ b/api/v3/ActionSchedule.php
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -24,70 +23,63 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
- * 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
- * {@getfields action_schedule_create}
+ * 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
  *
  * @return array
- *
- * {@getfields action_schedule_create}
  */
 function civicrm_api3_action_schedule_create($params) {
   civicrm_api3_verify_one_mandatory($params, NULL, array('start_action_date', 'absolute_date'));
   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');
 }
 
 /**
- * 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_action_schedule_create_spec(&$params) {
   $params['title']['api.required'] = TRUE;
   $params['mapping_id']['api.required'] = TRUE;
-  //  $params['entity_status']['api.required'] = TRUE;
   $params['entity_value']['api.required'] = TRUE;
 }
 
 /**
- * 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
- *
- * @access public
+ *   API result array
  */
 function civicrm_api3_action_schedule_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);