api/v3/PaymentProcessor.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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 PaymentProcessor.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Add/Update a PaymentProcessor.
  36  *
  37  * @param array $params
  38  *
  39  * @return array
  40  */
  41 function civicrm_api3_payment_processor_create($params) {
  42   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  43 }
  44
  45 /**
  46  * Adjust Metadata for Create action.
  47  *
  48  * The metadata is used for setting defaults, documentation & validation.
  49  *
  50  * @param array $params
  51  *   Array of parameters determined by getfields.
  52  */
  53 function _civicrm_api3_payment_processor_create_spec(&$params) {
  54   $params['payment_processor_type_id']['api.required'] = 1;
  55   $params['is_default']['api.default'] = 0;
  56   $params['is_test']['api.default'] = 0;
  57 }
  58
  59 /**
  60  * Deletes an existing PaymentProcessor.
  61  *
  62  * @param array $params
  63  *
  64  * @return array
  65  *   API result Array
  66  */
  67 function civicrm_api3_payment_processor_delete($params) {
  68   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  69 }
  70
  71 /**
  72  * Retrieve one or more PaymentProcessor.
  73  *
  74  * @param array $params
  75  *   Array of name/value pairs.
  76  *
  77  * @return array
  78  *   details of found PaymentProcessor
  79  */
  80 function civicrm_api3_payment_processor_get($params) {
  81   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  82 }
  83
  84
  85 /**
  86  * Set default getlist parameters.
  87  *
  88  * @see _civicrm_api3_generic_getlist_defaults
  89  *
  90  * @param array $request
  91  *
  92  * @return array
  93  */
  94 function _civicrm_api3_payment_processor_getlist_defaults(&$request) {
  95   return array(
  96     'description_field' => array(
  97       'payment_processor_type_id',
  98       'description',
  99     ),
 100     'params' => array(
 101       'is_test' => 0,
 102       'is_active' => 1,
 103     ),
 104   );
 105 }