api/v3/ContributionPage.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 /**
  30  * This api exposes CiviCRM contribution pages.
  31  *
  32  * @package CiviCRM_APIv3
  33  */
  34
  35 /**
  36  * Create or update a ContributionPage.
  37  *
  38  * @param array $params
  39  *   Array per getfields metadata.
  40  *
  41  * @return array
  42  *   api result array
  43  */
  44 function civicrm_api3_contribution_page_create($params) {
  45   $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'ContributionPage');
  46   CRM_Contribute_PseudoConstant::flush('contributionPageAll');
  47   CRM_Contribute_PseudoConstant::flush('contributionPageActive');
  48   return $result;
  49 }
  50
  51 /**
  52  * Adjust Metadata for Create action.
  53  *
  54  * The metadata is used for setting defaults, documentation & validation.
  55  *
  56  * @param array $params
  57  *   Array per getfields metadata.
  58  */
  59 function _civicrm_api3_contribution_page_create_spec(&$params) {
  60   $params['financial_type_id']['api.required'] = 1;
  61   $params['payment_processor']['api.aliases'] = ['payment_processor_id'];
  62   $params['is_active']['api.default'] = 1;
  63 }
  64
  65 /**
  66  * Returns array of ContributionPage(s) matching a set of one or more group properties.
  67  *
  68  * @param array $params
  69  *   Array per getfields metadata.
  70  *
  71  * @return array
  72  *   API Result array Array of matching contribution_pages
  73  */
  74 function civicrm_api3_contribution_page_get($params) {
  75   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  76 }
  77
  78 /**
  79  * Delete an existing ContributionPage.
  80  *
  81  * This method is used to delete any existing ContributionPage given its id.
  82  *
  83  * @param array $params
  84  *   Array per getfields metadata.
  85  *
  86  * @return array
  87  *   API result Array
  88  */
  89 function civicrm_api3_contribution_page_delete($params) {
  90   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  91 }
  92
  93 /**
  94  * Submit a ContributionPage.
  95  *
  96  * @param array $params
  97  *   Array per getfields metadata.
  98  *
  99  * @return array
 100  *   API result array
 101  */
 102 function civicrm_api3_contribution_page_submit($params) {
 103   $result = CRM_Contribute_Form_Contribution_Confirm::submit($params);
 104   return civicrm_api3_create_success($result, $params, 'ContributionPage', 'submit');
 105 }
 106
 107 /**
 108  * Validate ContributionPage submission parameters.
 109  *
 110  * @param array $params
 111  *   Array per getfields metadata.
 112  *
 113  * @return array
 114  *   API result array
 115  */
 116 function civicrm_api3_contribution_page_validate($params) {
 117   // If we are calling this as a result of a POST action (e.g validating a form submission before first getting payment
 118   // authorization from a payment processor like Paypal checkout) the lack of a qfKey will not result in a valid
 119   // one being generated so we generate one first.
 120   $originalRequest = $_REQUEST;
 121   $qfKey = CRM_Utils_Array::value('qfKey', $_REQUEST);
 122   if (!$qfKey) {
 123     $_REQUEST['qfKey'] = CRM_Core_Key::get('CRM_Core_Controller', TRUE);
 124   }
 125   $form = new CRM_Contribute_Form_Contribution_Main();
 126   $form->controller = new CRM_Core_Controller();
 127   $form->set('id', $params['id']);
 128   $form->preProcess();
 129   $errors = CRM_Contribute_Form_Contribution_Main::formRule($params, [], $form);
 130   if ($errors === TRUE) {
 131     $errors = [];
 132   }
 133   $_REQUEST = $originalRequest;
 134   return civicrm_api3_create_success($errors, $params, 'ContributionPage', 'validate');
 135 }
 136
 137 /**
 138  * Metadata for validate action.
 139  *
 140  * @param array $params
 141  */
 142 function _civicrm_api3_contribution_page_validate_spec(&$params) {
 143   $params['id'] = [
 144     'title' => ts('Contribution Page ID'),
 145     'api.required' => TRUE,
 146     'type' => CRM_Utils_Type::T_INT,
 147   ];
 148 }
 149
 150 /**
 151  * Set default getlist parameters.
 152  *
 153  * @see _civicrm_api3_generic_getlist_defaults
 154  *
 155  * @param array $request
 156  *
 157  * @return array
 158  */
 159 function _civicrm_api3_contribution_page_getlist_defaults(&$request) {
 160   return [
 161     'description_field' => [
 162       'intro_text',
 163     ],
 164     'params' => [
 165       'is_active' => 1,
 166     ],
 167   ];
 168 }