api/v3/PaymentProcessor.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  * File for the CiviCRM APIv3 PaymentProcessor functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_PaymentProcessor
  33  *
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  */
  36
  37 /**
  38  * Add/Update a PaymentProcessor
  39  *
  40  * Allowed @params array keys are:
  41  * {@getfields payment_processor_create}
  42  *
  43  * @param array $params
  44  *
  45  * @return array
  46  *   of newly created PaymentProcessor property values.
  47  * @access public
  48  */
  49 function civicrm_api3_payment_processor_create($params) {
  50   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  51 }
  52
  53 /**
  54  * Adjust Metadata for Create action
  55  *
  56  * The metadata is used for setting defaults, documentation & validation
  57  * @param array $params
  58  *   Array or parameters determined by getfields.
  59  */
  60 function _civicrm_api3_payment_processor_create_spec(&$params) {
  61   $params['payment_processor_type_id']['api.required'] = 1;
  62   $params['is_default']['api.default'] = 0;
  63   $params['is_test']['api.default'] = 0;
  64 }
  65
  66 /**
  67  * Deletes an existing PaymentProcessor
  68  *
  69  * @param array $params
  70  * {@getfields payment_processor_delete}
  71  *
  72  * @return array
  73  *   API result Array
  74  * @access public
  75  */
  76 function civicrm_api3_payment_processor_delete($params) {
  77   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  78 }
  79
  80 /**
  81  * Retrieve one or more PaymentProcessor
  82  *
  83  * @param mixed[] (reference) input parameters
  84  * {@getfields payment_processor_get}
  85  * @param array $params
  86  *   An associative array of name/value pairs.
  87  *
  88  * @return array
  89  *   details of found PaymentProcessor
  90  * @access public
  91  */
  92 function civicrm_api3_payment_processor_get($params) {
  93   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  94 }