returns AIM transaction data as an associative array

Author: acicali

src/Message/AIMResponse.php

@@ -14,7 +14,90 @@ class AIMResponse extends AbstractResponse
     public function __construct(RequestInterface $request, $data)
     {
         $this->request = $request;
-        $this->data = explode('|,|', substr($data, 1, -1));
+        $temp = explode('|,|', substr($data, 1, -1));
+
+		$response_fields = array(
+			'Response Code',
+			'Response Subcode',
+			'Response Reason Code',
+			'Response Reason Text',
+			'Authorization Code',
+			'AVS Response',
+			'Transaction ID',
+			'Invoice Number',
+			'Description',
+			'Amount',
+			'Method',
+			'Transaction Type',
+			'Customer ID',
+			'First Name',
+			'Last Name',
+			'Company',
+			'Address',
+			'City',
+			'State',
+			'ZIP Code',
+			'Country',
+			'Phone',
+			'Fax',
+			'Email Address',
+			'Ship To First Name',
+			'Ship To Last Name',
+			'Ship To Company',
+			'Ship To Address',
+			'Ship To City',
+			'Ship To State',
+			'Ship To ZIP Code',
+			'Ship To Country',
+			'Tax',
+			'Duty',
+			'Freight',
+			'Tax Exempt',
+			'Purchase Order Number',
+			'MD5 Hash',
+			'Card Code Response',
+			'Cardholder Authentication Verification Response',
+			'Account Number',
+			'Card Type',
+			'Split Tender ID',
+			'Requested Amount',
+			'Balance On Card'
+		);
+
+		$response = array();
+
+		foreach($response_fields as $field)
+		{
+			$response[$field] = array_shift($temp);
+		}
+
+		$response_codes = array(
+			1 => 'Approved',
+			2 => 'Declined',
+			3 => 'Error',
+			4 => 'Held for Review'
+		);
+
+		$avs_response_codes = array(
+			'A' => 'Address (Street) matches, ZIP does not',
+			'B' => 'Address information not provided for AVS check',
+			'E' => 'AVS error',
+			'G' => 'Non-U.S. Card Issuing Bank',
+			'N' => 'No Match on Address (Street) or ZIP',
+			'P' => 'AVS not applicable for this transaction',
+			'R' => 'Retry?System unavailable or timed out',
+			'S' => 'Service not supported by issuer',
+			'U' => 'Address information is unavailable',
+			'W' => 'Nine digit ZIP matches, Address (Street) does not',
+			'X' => 'Address (Street) and nine digit ZIP match',
+			'Y' => 'Address (Street) and five digit ZIP match',
+			'Z' => 'Five digit ZIP matches, Address (Street) does not'
+		);
+
+		$response['Response Code'] = $response_codes[$response['Response Code']];
+		$response['AVS Response'] = $avs_response_codes[$response['AVS Response']];
+
+		$this->data = $response;
 
         if (count($this->data) < 10) {
             throw new InvalidResponseException();
@@ -23,36 +106,36 @@ public function __construct(RequestInterface $request, $data)
 
     public function isSuccessful()
     {
-        return '1' === $this->getCode();
+        return $this->getCode() == 'Approved';
     }
 
     public function getCode()
     {
-        return $this->data[0];
+        return $this->data['Response Code'];
     }
 
     public function getReasonCode()
     {
-        return $this->data[2];
+        return $this->data['Response Reason Code'];
     }
 
     public function getMessage()
     {
-        return $this->data[3];
+        return $this->data['Response Reason Text'];
     }
 
     public function getAuthorizationCode()
     {
-        return $this->data[4];
+        return $this->data['Authorization Code'];
     }
 
     public function getAVSCode()
     {
-        return $this->data[5];
+        return $this->data['AVS Response'];
     }
 
     public function getTransactionReference()
     {
-        return $this->data[6];
+        return $this->data['Transaction ID'];
     }
 }