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