api/v3/PaymentProcessorType.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  * This api exposes CiviCRM payment processor types.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Create payment_processor type.
  36  *
  37  * @param array $params
  38  *   Associative array of property name/value pairs to insert in new payment_processor type.
  39  *
  40  * @return array
  41  */
  42 function civicrm_api3_payment_processor_type_create($params) {
  43   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'PaymentProcessorType');
  44 }
  45
  46 /**
  47  * Adjust Metadata for Create action.
  48  *
  49  * The metadata is used for setting defaults, documentation & validation.
  50  *
  51  * @param array $params
  52  *   Array of parameters determined by getfields.
  53  */
  54 function _civicrm_api3_payment_processor_type_create_spec(&$params) {
  55   $params['billing_mode']['api.required'] = 1;
  56   $params['class_name']['api.required'] = 1;
  57   $params['is_active']['api.default'] = 1;
  58   $params['is_recur']['api.default'] = FALSE;
  59   $params['name']['api.required'] = 1;
  60   $params['title']['api.required'] = 1;
  61   $params['payment_instrument_id']['api.default'] = 'Credit Card';
  62 }
  63
  64 /**
  65  * Get all payment_processor types.
  66  *
  67  * @param array $params
  68  *
  69  * @return array
  70  */
  71 function civicrm_api3_payment_processor_type_get($params) {
  72   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  73 }
  74
  75 /**
  76  * Delete a payment_processor type delete.
  77  *
  78  * @param array $params
  79  *
  80  * @return array
  81  *   API Result Array
  82  */
  83 function civicrm_api3_payment_processor_type_delete($params) {
  84   if ($params['id'] != NULL && !CRM_Utils_Rule::integer($params['id'])) {
  85     return civicrm_api3_create_error('Invalid value for payment processor type ID');
  86   }
  87
  88   $payProcTypeBAO = new CRM_Financial_BAO_PaymentProcessorType();
  89   $result = $payProcTypeBAO->del($params['id']);
  90   if (!$result) {
  91     return civicrm_api3_create_error('Could not delete payment processor type');
  92   }
  93   return civicrm_api3_create_success($result, $params, 'PaymentProcessorType', 'delete', $payProcTypeBAO);
  94 }