api/v3/ActionSchedule.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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  * File for the CiviCRM APIv3 for Scheduled Reminders
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_ActionSchedule
  33  *
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  */
  36
  37 /**
  38  * Get CiviCRM Action Schedule details.
  39  *
  40  * @param array $params
  41  *
  42  * @return array
  43  */
  44 function civicrm_api3_action_schedule_get($params) {
  45   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'action_schedule');
  46 }
  47
  48
  49 /**
  50  * Create a new Action Schedule.
  51  *
  52  * @param array $params
  53  *
  54  * @return array
  55  */
  56 function civicrm_api3_action_schedule_create($params) {
  57   civicrm_api3_verify_one_mandatory($params, NULL, array('start_action_date', 'absolute_date'));
  58   if (!array_key_exists('name', $params) && !array_key_exists('id', $params)) {
  59     $params['name'] = CRM_Utils_String::munge($params['title']);
  60   }
  61   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'action_schedule');
  62 }
  63
  64 /**
  65  * Adjust Metadata for Create action.
  66  *
  67  * The metadata is used for setting defaults, documentation & validation.
  68  *
  69  * @param array $params
  70  *   Array or parameters determined by getfields.
  71  */
  72 function _civicrm_api3_action_schedule_create_spec(&$params) {
  73   $params['title']['api.required'] = TRUE;
  74   $params['mapping_id']['api.required'] = TRUE;
  75   $params['entity_value']['api.required'] = TRUE;
  76 }
  77
  78 /**
  79  * Delete an existing action_schedule.
  80  *
  81  * @param array $params
  82  *   Array containing id of the action_schedule.
  83  *   to be deleted
  84  *
  85  * @return array
  86  *   API result array
  87  */
  88 function civicrm_api3_action_schedule_delete($params) {
  89   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  90 }