INFRA-132 - Batch 14 (g)

[civicrm-core.git] / api / v3 / PaymentProcessorType.php

diff --git a/api/v3/PaymentProcessorType.php b/api/v3/PaymentProcessorType.php
index 4ce8d997314a5a4efce8bf980cc4e63bc3e490e9..370361eb3e3a1335df2b02c4850aa4a7f8605b5b 100644 (file)
--- a/api/v3/PaymentProcessorType.php
+++ b/api/v3/PaymentProcessorType.php
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -42,36 +41,33 @@
  */
 
 /**
- * Function to create payment_processor type
+ * create payment_processor type
  *
- * @param  array $params   Associative array of property name/value pairs to insert in new payment_processor type.
+ * @param array $params
+ *   Associative array of property name/value pairs to insert in new payment_processor type.
  *
- * @return Newly created PaymentProcessor_type object
- * {@getfields PaymentProcessorType_create}
- * @access public
- * {@schema Core/PaymentProcessorType.xml}
+ * @return array
  */
 function civicrm_api3_payment_processor_type_create($params) {
-  $ids = array();
   if (isset($params['id']) && !CRM_Utils_Rule::integer($params['id'])) {
     return civicrm_api3_create_error('Invalid value for payment_processor type ID');
   }
 
-  $payProcType = new CRM_Financial_BAO_PaymentProcessorType();
-  $payProcType = CRM_Financial_BAO_PaymentProcessorType::create($params);
+  $paymentProcessorType = CRM_Financial_BAO_PaymentProcessorType::create($params);
 
   $relType = array();
 
-  _civicrm_api3_object_to_array($payProcType, $relType[$payProcType->id]);
+  _civicrm_api3_object_to_array($paymentProcessorType, $relType[$paymentProcessorType->id]);
 
-  return civicrm_api3_create_success($relType, $params, 'payment_processor_type', 'create', $payProcType);
+  return civicrm_api3_create_success($relType, $params, 'payment_processor_type', 'create', $paymentProcessorType);
 }
 
 /**
  * Adjust Metadata for Create action
  *
  * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ *   Array or parameters determined by getfields.
  */
 function _civicrm_api3_payment_processor_type_create_spec(&$params) {
   $params['billing_mode']['api.required'] = 1;
@@ -84,11 +80,9 @@ function _civicrm_api3_payment_processor_type_create_spec(&$params) {
 }
 
 /**
- * Function to get all payment_processor type
- * retruns  An array of PaymentProcessor_type
- * @access  public
- * {@getfields PaymentProcessorType_get}
- * @example PaymentProcessorTypeGet.php
+ * get all payment_processor types
+ * @param array $params
+ * @return array
  */
 function civicrm_api3_payment_processor_type_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -97,12 +91,10 @@ function civicrm_api3_payment_processor_type_get($params) {
 /**
  * Delete a payment_processor type delete
  *
- * @param  id of payment_processor type  $id
+ * @param array $params
  *
- * @return array API Result Array
- * {@getfields PaymentProcessorType_delete}
- * @static void
- * @access public
+ * @return array
+ *   API Result Array
  */
 function civicrm_api3_payment_processor_type_delete($params) {
   if ($params['id'] != NULL && !CRM_Utils_Rule::integer($params['id'])) {