3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM recurring entity records.
31 * @package CiviCRM_APIv3
35 * Retrieve a recurring entity.
37 * @param array $params
42 function civicrm_api3_recurring_entity_get($params) {
43 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
47 * Adjust Metadata for Get action.
49 * The metadata is used for setting defaults, documentation & validation.
51 * @param array $params
52 * Array of parameters determined by getfields.
54 function _civicrm_api3_recurring_entity_get_spec(&$params) {
55 $params['entity_table']['options'] = array(
56 'civicrm_event' => 'civicrm_event',
57 'civicrm_activity' => 'civicrm_activity',
62 * Add or update a recurring entity.
64 * @param array $params
68 function civicrm_api3_recurring_entity_create($params) {
69 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
73 * Adjust Metadata for Create action.
75 * The metadata is used for setting defaults, documentation & validation.
77 * @param array $params
78 * Array of parameters determined by getfields.
80 function _civicrm_api3_recurring_entity_create_spec(&$params) {
81 $params['entity_table']['options'] = array(
82 'civicrm_event' => 'civicrm_event',
83 'civicrm_activity' => 'civicrm_activity',
85 $params['entity_table']['api.required'] = 1;
89 * Deletes an existing ReportInstance.
91 * @param array $params
95 function civicrm_api3_recurring_entity_delete($params) {
96 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);