Merge pull request #4958 from pratikshad/code-cleanup-batch-19

[civicrm-core.git] / CRM / Core / Payment / PaymentExpress.php

diff --git a/CRM/Core/Payment/PaymentExpress.php b/CRM/Core/Payment/PaymentExpress.php
index 4927ca96586b0b375d677055aab14b71d89751eb..7b181db47f369d0324cd3cee623c095fb717763d 100644 (file)
--- a/CRM/Core/Payment/PaymentExpress.php
+++ b/CRM/Core/Payment/PaymentExpress.php
@@ -46,14 +46,14 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment {
    * pattern and cache the instance in this variable
    *
    * @var object
-   * @static
    */
   static private $_singleton = NULL;
 
   /**
    * Constructor
    *
-   * @param string $mode the mode of operation: live or test
+   * @param string $mode
+   *   The mode of operation: live or test.
    *
    * @param $paymentProcessor
    *
@@ -66,33 +66,13 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment {
     $this->_processorName = ts('DPS Payment Express');
   }
 
-  /**
-   * Singleton function used to manage this object
-   *
-   * @param string $mode the mode of operation: live or test
-   *
-   * @param object $paymentProcessor
-   * @param null $paymentForm
-   * @param bool $force
-   *
-   * @return object
-   * @static
-   */
-  public static function &singleton($mode = 'test', &$paymentProcessor, &$paymentForm = NULL, $force = FALSE) {
-    $processorName = $paymentProcessor['name'];
-    if (self::$_singleton[$processorName] === NULL) {
-      self::$_singleton[$processorName] = new CRM_Core_Payment_PaymentExpress($mode, $paymentProcessor);
-    }
-    return self::$_singleton[$processorName];
-  }
-
   /**
    * This function checks to see if we have the right config values
    *
    * @internal param string $mode the mode we are operating in (live or test)
    *
-   * @return string the error message if any
-   * @public
+   * @return string
+   *   the error message if any
    */
   public function checkConfig() {
     $config = CRM_Core_Config::singleton();
@@ -146,9 +126,11 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment {
    * This function collects all the information from a web/api form and invokes
    * the relevant payment processor specific functions to perform the transaction
    *
-   * @param  array $params assoc array of input parameters for this transaction
+   * @param array $params
+   *   Assoc array of input parameters for this transaction.
    *
-   * @return array the result in an nice formatted array (or an error object)
+   * @return array
+   *   the result in an nice formatted array (or an error object)
    * @abstract
    */
   public function doDirectPayment(&$params) {
@@ -158,12 +140,12 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment {
   /**
    * Main transaction function
    *
-   * @param array $params name value pair of contribution data
+   * @param array $params
+   *   Name value pair of contribution data.
    *
    * @param $component
    *
    * @return void
-   * @access public
    */
   public function doTransferCheckout(&$params, $component) {
     $component = strtolower($component);
@@ -187,19 +169,18 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment {
       );
     }
 
-
     /*
-         * Build the private data string to pass to DPS, which they will give back to us with the
-         *
-         * transaction result.  We are building this as a comma-separated list so as to avoid long URLs.
-         *
-         * Parameters passed: a=contactID, b=contributionID,c=contributionTypeID,d=invoiceID,e=membershipID,f=participantID,g=eventID
-         */
+     * Build the private data string to pass to DPS, which they will give back to us with the
+     *
+     * transaction result.  We are building this as a comma-separated list so as to avoid long URLs.
+     *
+     * Parameters passed: a=contactID, b=contributionID,c=contributionTypeID,d=invoiceID,e=membershipID,f=participantID,g=eventID
+     */
 
     $privateData = "a={$params['contactID']},b={$params['contributionID']},c={$params['contributionTypeID']},d={$params['invoiceID']}";
 
     if ($component == 'event') {
-    $merchantRef = substr($params['contactID'] . "-" . $params['contributionID'] . " " . substr($params['description'], 27, 20), 0, 24);
+      $merchantRef = substr($params['contactID'] . "-" . $params['contributionID'] . " " . substr($params['description'], 27, 20), 0, 24);
       $privateData .= ",f={$params['participantID']},g={$params['eventID']}";
     }
     elseif ($component == 'contribute') {
@@ -217,7 +198,7 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment {
       'MerchantReference' => $merchantRef,
       'TxnData1' => $params['qfKey'],
       'TxnData2' => $privateData,
-      'TxnData3' => $component . ",".$this->_paymentProcessor['id'],
+      'TxnData3' => $component . "," . $this->_paymentProcessor['id'],
       'TxnType' => 'Purchase',
       // Leave this empty for now, causes an error with DPS if we populate it
       'TxnId' => '',
@@ -228,9 +209,8 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment {
     CRM_Utils_Hook::alterPaymentProcessorParams($this, $params, $dpsParams);
 
     /*
-         *  determine whether method is pxaccess or pxpay by whether signature (mac key) is defined
-         */
-
+     *  determine whether method is pxaccess or pxpay by whether signature (mac key) is defined
+     */
 
     if (empty($this->_paymentProcessor['signature'])) {
       /*
@@ -269,7 +249,7 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment {
     }
     else {
       $processortype = "pxaccess";
-      require_once ('PaymentExpress/pxaccess.inc.php');
+      require_once 'PaymentExpress/pxaccess.inc.php';
       // URL
       $PxAccess_Url = $this->_paymentProcessor['url_site'];
       // User ID
@@ -295,4 +275,3 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment {
     }
   }
 }
-