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  * new version of civicrm apis. See blog post at
  30  * http://civicrm.org/node/131
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_Contact
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * $Id: PaymentProcessorType.php 30415 2010-10-29 12:02:47Z shot $
  36  *
  37  */
  38
  39 /**
  40  * Include common API util functions
  41  */
  42
  43 /**
  44  * create payment_processor type
  45  *
  46  * @param array $params
  47  *   Associative array of property name/value pairs to insert in new payment_processor type.
  48  *
  49  * @return array
  50  * {@getfields PaymentProcessorType_create}
  51  * @access public
  52  * {@schema Core/PaymentProcessorType.xml}
  53  */
  54 function civicrm_api3_payment_processor_type_create($params) {
  55   $ids = array();
  56   if (isset($params['id']) && !CRM_Utils_Rule::integer($params['id'])) {
  57     return civicrm_api3_create_error('Invalid value for payment_processor type ID');
  58   }
  59
  60   $payProcType = new CRM_Financial_BAO_PaymentProcessorType();
  61   $payProcType = CRM_Financial_BAO_PaymentProcessorType::create($params);
  62
  63   $relType = array();
  64
  65   _civicrm_api3_object_to_array($payProcType, $relType[$payProcType->id]);
  66
  67   return civicrm_api3_create_success($relType, $params, 'payment_processor_type', 'create', $payProcType);
  68 }
  69
  70 /**
  71  * Adjust Metadata for Create action
  72  *
  73  * The metadata is used for setting defaults, documentation & validation
  74  * @param array $params
  75  *   Array or parameters determined by getfields.
  76  */
  77 function _civicrm_api3_payment_processor_type_create_spec(&$params) {
  78   $params['billing_mode']['api.required'] = 1;
  79   $params['class_name']['api.required'] = 1;
  80   $params['is_active']['api.default'] = 1;
  81   $params['is_recur']['api.default'] = FALSE;
  82   // FIXME bool support // $params['is_recur']['api.required'] = 1;
  83   $params['name']['api.required'] = 1;
  84   $params['title']['api.required'] = 1;
  85 }
  86
  87 /**
  88  * get all payment_processor type
  89  * retruns  An array of PaymentProcessor_type
  90  * @access  public
  91  * {@getfields PaymentProcessorType_get}
  92  * @example PaymentProcessorTypeGet.php
  93  * @param $params
  94  * @return array
  95  */
  96 function civicrm_api3_payment_processor_type_get($params) {
  97   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  98 }
  99
 100 /**
 101  * Delete a payment_processor type delete
 102  *
 103  * @param id of payment_processor type $id
 104  *
 105  * @return array
 106  *   API Result Array
 107  * {@getfields PaymentProcessorType_delete}
 108  * @static
 109  * @access public
 110  */
 111 function civicrm_api3_payment_processor_type_delete($params) {
 112   if ($params['id'] != NULL && !CRM_Utils_Rule::integer($params['id'])) {
 113     return civicrm_api3_create_error('Invalid value for payment processor type ID');
 114   }
 115
 116   $payProcTypeBAO = new CRM_Financial_BAO_PaymentProcessorType();
 117   $result = $payProcTypeBAO->del($params['id']);
 118   if (!$result) {
 119     return civicrm_api3_create_error('Could not delete payment processor type');
 120   }
 121   return civicrm_api3_create_success($result, $params, 'payment_processor_type', 'delete', $payProcTypeBAO);
 122 }