api/v3/ActionSchedule.php

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