api/v3/ContributionPage.php

   1 <?php
   2 /*
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.6                                                |
   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 /**
  31  * File for the CiviCRM APIv3 group functions
  32  *
  33  * @package CiviCRM_APIv3
  34  * @subpackage API_ContributionPage
  35  * @copyright CiviCRM LLC (c) 20042012
  36  */
  37
  38 /**
  39  * Create or update a contribution_page
  40  *
  41  * @param array $params
  42  *   Associative array of property.
  43  *                       name/value pairs to insert in new 'contribution_page'
  44  * @example ContributionPageCreate.php Std Create example
  45  *
  46  * @return array api result array
  47  * {@getfields contribution_page_create}
  48  * @access public
  49  */
  50 function civicrm_api3_contribution_page_create($params) {
  51   $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  52   CRM_Contribute_PseudoConstant::flush('contributionPageAll');
  53   CRM_Contribute_PseudoConstant::flush('contributionPageActive');
  54   return $result;
  55 }
  56
  57 /**
  58  * Adjust Metadata for Create action
  59  *
  60  * The metadata is used for setting defaults, documentation & validation
  61  * @param array $params
  62  *   Array or parameters determined by getfields.
  63  */
  64 function _civicrm_api3_contribution_page_create_spec(&$params) {
  65   $params['financial_type_id']['api.required'] = 1;
  66   $params['payment_processor']['api.aliases'] = array('payment_processor_id');
  67   $params['is_active']['api.default'] = 1;
  68 }
  69
  70 /**
  71  * Returns array of contribution_pages  matching a set of one or more group properties
  72  *
  73  * @param array $params
  74  *   Array of one or more valid property_name=>value pairs.
  75  *
  76  * @return array API Result array Array of matching contribution_pages
  77  * {@getfields contribution_page_get}
  78  * @access public
  79  */
  80 function civicrm_api3_contribution_page_get($params) {
  81   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  82 }
  83
  84 /**
  85  * delete an existing contribution_page
  86  *
  87  * This method is used to delete any existing contribution_page. id of the group
  88  * to be deleted is required field in $params array
  89  *
  90  * @param array $params
  91  *   Array containing id of the group.
  92  *                       to be deleted
  93  *
  94  * @return array API result Array
  95  * {@getfields contribution_page_delete}
  96  * @access public
  97  */
  98 function civicrm_api3_contribution_page_delete($params) {
  99   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 100 }
 101
 102 /**
 103  * delete an existing contribution_page
 104  *
 105  * This method is used to delete any existing contribution_page. id of the group
 106  * to be deleted is required field in $params array
 107  *
 108  * @param array $params
 109  *   (reference) array containing id of the group.
 110  *                       to be deleted
 111  *
 112  * @return array API result array
 113  * {@getfields contribution_page_delete}
 114  * @access public
 115  */
 116 function civicrm_api3_contribution_page_submit($params) {
 117   $result = CRM_Contribute_Form_Contribution_Confirm::submit($params);
 118   return civicrm_api3_create_success($result, $params, 'contribution_page', 'submit');
 119 }