api/v3/RecurringEntity.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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 recurring entity records.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Retrieve a recurring entity.
  36  *
  37  * @param array $params
  38  *   Input parameters.
  39  *
  40  * @return array
  41  */
  42 function civicrm_api3_recurring_entity_get($params) {
  43   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  44 }
  45
  46 /**
  47  * Adjust Metadata for Get action.
  48  *
  49  * The metadata is used for setting defaults, documentation & validation.
  50  *
  51  * @param array $params
  52  *   Array of parameters determined by getfields.
  53  */
  54 function _civicrm_api3_recurring_entity_get_spec(&$params) {
  55   $params['entity_table']['options'] = [
  56     'civicrm_event' => 'civicrm_event',
  57     'civicrm_activity' => 'civicrm_activity',
  58   ];
  59 }
  60
  61 /**
  62  * Add or update a recurring entity.
  63  *
  64  * @param array $params
  65  *
  66  * @return array
  67  */
  68 function civicrm_api3_recurring_entity_create($params) {
  69   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'RecurringEntity');
  70 }
  71
  72 /**
  73  * Adjust Metadata for Create action.
  74  *
  75  * The metadata is used for setting defaults, documentation & validation.
  76  *
  77  * @param array $params
  78  *   Array of parameters determined by getfields.
  79  */
  80 function _civicrm_api3_recurring_entity_create_spec(&$params) {
  81   $params['entity_table']['options'] = [
  82     'civicrm_event' => 'civicrm_event',
  83     'civicrm_activity' => 'civicrm_activity',
  84   ];
  85   $params['entity_table']['api.required'] = 1;
  86 }
  87
  88 /**
  89  * Deletes an existing ReportInstance.
  90  *
  91  * @param array $params
  92  *
  93  * @return array
  94  */
  95 function civicrm_api3_recurring_entity_delete($params) {
  96   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  97 }