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 e536683819ad78b4c8bb40251688306c51fe9ddd..08a1d230fec2a73da00cc2fdcde9e58f8f8855ec 100644 (file)
--- a/CRM/Financial/BAO/PaymentProcessor.php
+++ b/CRM/Financial/BAO/PaymentProcessor.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.3                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,7 +28,7 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -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();
@@ -68,7 +74,7 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces
     $processor->save();
     // CRM-11826, add entry in civicrm_entity_financial_account
     // if financial_account_id is not NULL
-    if (CRM_Utils_Array::value('financial_account_id', $params)) {
+    if (!empty($params['financial_account_id'])) {
       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' "));
       $values = array(
         'entity_table' => 'civicrm_payment_processor',
@@ -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