api/v3/Cxn - Tweak error

[civicrm-core.git] / api / v3 / ActionSchedule.php

diff --git a/api/v3/ActionSchedule.php b/api/v3/ActionSchedule.php
index b2b63bf48dcb71231c0d001973118c0f3a848b5a..44152465dcf5d7b10547a5a9393026952dc00721 100644 (file)
--- a/api/v3/ActionSchedule.php
+++ b/api/v3/ActionSchedule.php
@@ -1,10 +1,9 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -24,95 +23,64 @@
  | 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) {
-  $bao = new CRM_Core_BAO_ActionSchedule();
-  _civicrm_api3_dao_set_filter($bao, $params, true, 'ActionSchedule');
-  $actionSchedules = _civicrm_api3_dao_to_array($bao, $params, true,'ActionSchedule');
-
-  return civicrm_api3_create_success($actionSchedules, $params, 'action_schedule', 'get', $bao);
+  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) {
-  if (empty($params['id'])) {
-    // an update does not require any mandatory parameters
-    civicrm_api3_verify_one_mandatory($params,
-      NULL,
-      array(
-        'title','mapping_id', 'entity_status', 'entity_value',
-      )
-    );
-  }
-
-  $ids = array();
-  if (isset($params['id']) && !CRM_Utils_Rule::integer($params['id'])) {
-    return civicrm_api3_create_error('Invalid value for ID');
-  }
-
+  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']);
   }
-
-  $actionSchedule = new CRM_Core_BAO_ActionSchedule();
-  $actionSchedule = CRM_Core_BAO_ActionSchedule::add($params, $ids);
-
-  $actSchedule = array();
-
-  _civicrm_api3_object_to_array($actionSchedule, $actSchedule[$actionSchedule->id]);
-
-  return civicrm_api3_create_success($actSchedule, $params, 'action_schedule', 'create', $actionSchedule);
+  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
+ * @param array $params
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_action_schedule_create_spec(&$params) {
-  unset($params['version']);
+  $params['title']['api.required'] = TRUE;
+  $params['mapping_id']['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.
  *
- * @param array $params  (reference) array containing id of the action_schedule
- *                       to be deleted
- *
- * @return array  (referance) returns flag true if successfull, error
- *                message otherwise
- *
- * @access public
+ * @return array
+ *   API result array
  */
 function civicrm_api3_action_schedule_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
-
-