api/v3/ActionSchedule.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * This api exposes CiviCRM Scheduled Reminders.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Get CiviCRM ActionSchedule details.
  36  *
  37  * @param array $params
  38  *
  39  * @return array
  40  *   API result array
  41  */
  42 function civicrm_api3_action_schedule_get($params) {
  43   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'ActionSchedule');
  44 }
  45
  46
  47 /**
  48  * Create a new ActionSchedule.
  49  *
  50  * @param array $params
  51  *
  52  * @return array
  53  */
  54 function civicrm_api3_action_schedule_create($params) {
  55   civicrm_api3_verify_one_mandatory($params, NULL, array('start_action_date', 'absolute_date'));
  56   if (!array_key_exists('name', $params) && !array_key_exists('id', $params)) {
  57     $params['name'] = CRM_Utils_String::munge($params['title']);
  58   }
  59   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'ActionSchedule');
  60 }
  61
  62 /**
  63  * Adjust Metadata for Create action.
  64  *
  65  * The metadata is used for setting defaults, documentation & validation.
  66  *
  67  * @param array $params
  68  *   Array of parameters determined by getfields.
  69  */
  70 function _civicrm_api3_action_schedule_create_spec(&$params) {
  71   $params['title']['api.required'] = TRUE;
  72   $params['mapping_id']['api.required'] = TRUE;
  73   $params['entity_value']['api.required'] = TRUE;
  74 }
  75
  76 /**
  77  * Delete an existing ActionSchedule.
  78  *
  79  * @param array $params
  80  *   Array containing id of the action_schedule to be deleted.
  81  *
  82  * @return array
  83  *   API result array
  84  */
  85 function civicrm_api3_action_schedule_delete($params) {
  86   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  87 }