api/v3/ContributionRecur.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   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 group functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_ContributionRecur
  33  * @copyright CiviCRM LLC (c) 2004-2014
  34  */
  35
  36 /**
  37  * Create or update a contribution_recur
  38  *
  39  * @param array $params  Associative array of property
  40  *                       name/value pairs to insert in new 'contribution_recur'
  41  * @example ContributionRecurCreate.php Std Create example
  42  *
  43  * @return array api result array
  44  * {@getfields contribution_recur_create}
  45  * @access public
  46  */
  47 function civicrm_api3_contribution_recur_create($params) {
  48   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  49 }
  50
  51 /**
  52  * Adjust Metadata for Create action
  53  *
  54  * The metadata is used for setting defaults, documentation & validation
  55  * @param array $params array or parameters determined by getfields
  56  */
  57 function _civicrm_api3_contribution_recur_create_spec(&$params) {
  58   $params['contact_id']['api.required'] = 1;
  59   $params['create_date']['api.default'] = 'now';
  60   $params['frequency_interval']['api.required'] = 1;
  61   $params['start_date']['api.default'] = 'now';
  62 }
  63
  64 /**
  65  * Returns array of contribution_recurs  matching a set of one or more group properties
  66  *
  67  * @param array $params  (referance) Array of one or more valid
  68  *                       property_name=>value pairs. If $params is set
  69  *                       as null, all contribution_recurs will be returned
  70  *
  71  * @return array  (referance) Array of matching contribution_recurs
  72  * {@getfields contribution_recur_get}
  73  * @access public
  74  */
  75 function civicrm_api3_contribution_recur_get($params) {
  76   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  77 }
  78
  79 /**
  80  * delete an existing contribution_recur
  81  *
  82  * This method is used to delete any existing contribution_recur. id of the group
  83  * to be deleted is required field in $params array
  84  *
  85  * @param array $params  (reference) array containing id of the group
  86  *                       to be deleted
  87  *
  88  * @return array  (referance) returns flag true if successfull, error
  89  *                message otherwise
  90  * {@getfields contribution_recur_delete}
  91  * @access public
  92  */
  93 function civicrm_api3_contribution_recur_delete($params) {
  94   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  95 }
  96