api/v3/ContributionPage.php

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