Update financial items for change selection.

[civicrm-core.git] / CRM / Financial / BAO / PaymentProcessor.php

diff --git a/CRM/Financial/BAO/PaymentProcessor.php b/CRM/Financial/BAO/PaymentProcessor.php
index 574bd20162b32e190a09cdc8e71b85bbb07e0be1..08a1d230fec2a73da00cc2fdcde9e58f8f8855ec 100644 (file)
--- a/CRM/Financial/BAO/PaymentProcessor.php
+++ b/CRM/Financial/BAO/PaymentProcessor.php
@@ -48,6 +48,12 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces
    *
    * @params array parameters for Processor entity
    */
+  /**
+   * @param $params
+   *
+   * @return CRM_Financial_DAO_PaymentProcessor
+   * @throws Exception
+   */
   static function create($params) {
     // FIXME Reconcile with CRM_Admin_Form_PaymentProcessor::updatePaymentProcessor
     $processor = new CRM_Financial_DAO_PaymentProcessor();
@@ -147,7 +153,10 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces
   /**
    * Function  to delete payment processor
    *
-   * @param  int  $paymentProcessorId     ID of the processor to be deleted.
+   * @param $paymentProcessorID
+   *
+   * @return null
+   * @internal param int $paymentProcessorId ID of the processor to be deleted.
    *
    * @access public
    * @static
@@ -208,6 +217,13 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces
     }
   }
 
+  /**
+   * @param $paymentProcessorIDs
+   * @param $mode
+   *
+   * @return array
+   * @throws Exception
+   */
   static function getPayments($paymentProcessorIDs, $mode) {
     if (!$paymentProcessorIDs) {
       CRM_Core_Error::fatal(ts('Invalid value passed to getPayment function'));
@@ -270,10 +286,11 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces
   /**
    * Function to retrieve payment processor id / info/ object based on component-id.
    *
-   * @param int    $componentID id of a component
-   * @param string $component   component
-   * @param string $type        type of payment information to be retrieved
+   * @param $entityID
+   * @param string $component component
+   * @param string $type type of payment information to be retrieved
    *
+   * @internal param int $componentID id of a component
    * @return id / array / object based on type
    * @static
    * @access public