Merge pull request #5944 from colemanw/CRM-16310
[civicrm-core.git] / CRM / Core / Payment / PaymentExpress.php
index ee7f4b59dc0396c61c04af38672b26081d33fc78..b87834024ab645acbde16ca909020cdde1e444e6 100644 (file)
@@ -21,7 +21,7 @@
   | GNU Affero General Public License or the licensing of CiviCRM,     |
   | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
   +--------------------------------------------------------------------+
-*/
+ */
 
 
 /*
@@ -46,12 +46,11 @@ 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
+   * Constructor.
    *
    * @param string $mode
    *   The mode of operation: live or test.
@@ -68,7 +67,7 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment {
   }
 
   /**
-   * This function checks to see if we have the right config values
+   * 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)
    *
@@ -129,17 +128,13 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment {
    *
    * @param array $params
    *   Assoc array of input parameters for this transaction.
-   *
-   * @return array
-   *   the result in an nice formatted array (or an error object)
-   * @abstract
    */
   public function doDirectPayment(&$params) {
     CRM_Core_Error::fatal(ts('This function is not implemented'));
   }
 
   /**
-   * Main transaction function
+   * Main transaction function.
    *
    * @param array $params
    *   Name value pair of contribution data.
@@ -171,12 +166,12 @@ 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']}";
 
@@ -210,8 +205,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'])) {
       /*
@@ -275,4 +270,5 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment {
       CRM_Utils_System::redirect($request_string);
     }
   }
+
 }