api/v3/ActionSchedule.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * This api exposes CiviCRM Scheduled Reminders.
  14  *
  15  * @package CiviCRM_APIv3
  16  */
  17
  18 /**
  19  * Get CiviCRM ActionSchedule details.
  20  *
  21  * @param array $params
  22  *
  23  * @return array
  24  *   API result array
  25  */
  26 function civicrm_api3_action_schedule_get($params) {
  27   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'ActionSchedule');
  28 }
  29
  30 /**
  31  * Create a new ActionSchedule.
  32  *
  33  * @param array $params
  34  *
  35  * @return array
  36  */
  37 function civicrm_api3_action_schedule_create($params) {
  38   civicrm_api3_verify_one_mandatory($params, NULL, ['start_action_date', 'absolute_date']);
  39   if (!array_key_exists('name', $params) && !array_key_exists('id', $params)) {
  40     $params['name'] = CRM_Utils_String::munge($params['title']);
  41   }
  42   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'ActionSchedule');
  43 }
  44
  45 /**
  46  * Adjust Metadata for Create action.
  47  *
  48  * The metadata is used for setting defaults, documentation & validation.
  49  *
  50  * @param array $params
  51  *   Array of parameters determined by getfields.
  52  */
  53 function _civicrm_api3_action_schedule_create_spec(&$params) {
  54   $params['title']['api.required'] = TRUE;
  55   $params['mapping_id']['api.required'] = TRUE;
  56   $params['entity_value']['api.required'] = TRUE;
  57 }
  58
  59 /**
  60  * Delete an existing ActionSchedule.
  61  *
  62  * @param array $params
  63  *   Array containing id of the action_schedule to be deleted.
  64  *
  65  * @return array
  66  *   API result array
  67  */
  68 function civicrm_api3_action_schedule_delete($params) {
  69   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  70 }