Merge pull request #126 from thephpleague/issue125

Fixes to the query functions.

composer.json

@@ -28,7 +28,10 @@
         "psr-4": { "Omnipay\\AuthorizeNet\\" : "src/" }
     },
     "require": {
-        "omnipay/common": "^3"
+        "omnipay/common": "^3",
+        "ext-json": "*",
+        "ext-libxml": "*",
+        "ext-simplexml": "*"
     },
     "require-dev": {
         "omnipay/tests": "^3",

src/AIMGateway.php

@@ -3,12 +3,14 @@
 namespace Omnipay\AuthorizeNet;
 
 use Omnipay\AuthorizeNet\Message\AIMAuthorizeRequest;
+use Omnipay\AuthorizeNet\Message\AIMCaptureOnlyRequest;
 use Omnipay\AuthorizeNet\Message\AIMCaptureRequest;
-use Omnipay\AuthorizeNet\Message\AIMPaymentPlanQueryResponse;
+use Omnipay\AuthorizeNet\Message\Query\AIMPaymentPlanQueryResponse;
 use Omnipay\AuthorizeNet\Message\AIMPurchaseRequest;
-use Omnipay\AuthorizeNet\Message\QueryRequest;
 use Omnipay\AuthorizeNet\Message\AIMRefundRequest;
 use Omnipay\AuthorizeNet\Message\AIMVoidRequest;
+use Omnipay\AuthorizeNet\Message\Query\AIMPaymentPlansQueryRequest;
+use Omnipay\AuthorizeNet\Message\Query\QueryResponse;
 use Omnipay\Common\AbstractGateway;
 
 /**
@@ -126,7 +128,10 @@ public function setDuplicateWindow($value)
      */
     public function authorize(array $parameters = array())
     {
-        return $this->createRequest('\Omnipay\AuthorizeNet\Message\AIMAuthorizeRequest', $parameters);
+        return $this->createRequest(
+            AIMAuthorizeRequest::class,
+            $parameters
+        );
     }
 
     /**
@@ -135,7 +140,10 @@ public function authorize(array $parameters = array())
      */
     public function capture(array $parameters = array())
     {
-        return $this->createRequest('\Omnipay\AuthorizeNet\Message\AIMCaptureRequest', $parameters);
+        return $this->createRequest(
+            AIMCaptureRequest::class,
+            $parameters
+        );
     }
 
     /**
@@ -144,7 +152,10 @@ public function capture(array $parameters = array())
      */
     public function captureOnly(array $parameters = array())
     {
-        return $this->createRequest('\Omnipay\AuthorizeNet\Message\AIMCaptureOnlyRequest', $parameters);
+        return $this->createRequest(
+            AIMCaptureOnlyRequest::class,
+            $parameters
+        );
     }
 
     /**
@@ -153,7 +164,10 @@ public function captureOnly(array $parameters = array())
      */
     public function purchase(array $parameters = array())
     {
-        return $this->createRequest('\Omnipay\AuthorizeNet\Message\AIMPurchaseRequest', $parameters);
+        return $this->createRequest(
+            AIMPurchaseRequest::class,
+            $parameters
+        );
     }
 
     /**
@@ -162,7 +176,10 @@ public function purchase(array $parameters = array())
      */
     public function void(array $parameters = array())
     {
-        return $this->createRequest('\Omnipay\AuthorizeNet\Message\AIMVoidRequest', $parameters);
+        return $this->createRequest(
+            AIMVoidRequest::class,
+            $parameters
+        );
     }
 
     /**
@@ -171,7 +188,10 @@ public function void(array $parameters = array())
      */
     public function refund(array $parameters = array())
     {
-        return $this->createRequest('\Omnipay\AuthorizeNet\Message\AIMRefundRequest', $parameters);
+        return $this->createRequest(
+            AIMRefundRequest::class,
+            $parameters
+        );
     }
 
     /**
@@ -180,16 +200,22 @@ public function refund(array $parameters = array())
      */
     public function paymentPlansQuery(array $parameters = array())
     {
-        return $this->createRequest('\Omnipay\AuthorizeNet\Message\Query\AIMPaymentPlansQueryRequest', $parameters);
+        return $this->createRequest(
+            Message\Query\AIMPaymentPlansQueryRequest::class,
+            $parameters
+        );
     }
 
     /**
      * @param array $parameters
-     * @return AIMPaymentPlanQueryResponse
+     * @return \Omnipay\Common\Message\AbstractRequest
      */
     public function paymentPlanQuery(array $parameters = array())
     {
-        return $this->createRequest('\Omnipay\AuthorizeNet\Message\Query\AIMPaymentPlanQueryRequest', $parameters);
+        return $this->createRequest(
+            Message\Query\AIMPaymentPlanQueryRequest::class,
+            $parameters
+        );
     }
 
     /**
@@ -198,33 +224,45 @@ public function paymentPlanQuery(array $parameters = array())
      */
     public function query(array $parameters = array())
     {
-        return $this->createRequest('\Omnipay\AuthorizeNet\Message\Query\QueryRequest', $parameters);
+        return $this->createRequest(
+            Message\Query\QueryRequest::class,
+            $parameters
+        );
     }
 
     /**
      * @param array $parameters
-     * @return QueryBatchResponse
+     * @return Message\Query\QueryBatchRequest
      */
     public function queryBatch(array $parameters = array())
     {
-        return $this->createRequest('\Omnipay\AuthorizeNet\Message\QueryBatchRequest', $parameters);
+        return $this->createRequest(
+            Message\Query\QueryBatchRequest::class,
+            $parameters
+        );
     }
 
     /**
      * @param array $parameters
-     * @return QueryBatchDetailResponse
+     * @return Message\Query\QueryBatchDetailRequest
      */
     public function queryBatchDetail(array $parameters = array())
     {
-        return $this->createRequest('\Omnipay\AuthorizeNet\Message\QueryBatchDetailRequest', $parameters);
+        return $this->createRequest(
+            Message\Query\QueryBatchDetailRequest::class,
+            $parameters
+        );
     }
 
     /**
      * @param array $parameters
-     * @return QueryDetailResponse
+     * @return Message\Query\QueryDetailRequest
      */
     public function queryDetail(array $parameters = array())
     {
-        return $this->createRequest('\Omnipay\AuthorizeNet\Message\QueryDetailRequest', $parameters);
+        return $this->createRequest(
+            Message\Query\QueryDetailRequest::class,
+            $parameters
+        );
     }
 }

src/DPMGateway.php

@@ -14,6 +14,8 @@ public function getName()
 
     /**
      * Helper to generate the authorize direct-post form.
+     * @param array $parameters
+     * @return \Omnipay\Common\Message\AbstractRequest
      */
     public function authorize(array $parameters = array())
     {

src/Message/AIMAbstractRequest.php

@@ -276,8 +276,8 @@ protected function addReferenceId(\SimpleXMLElement $data)
 
     protected function addTransactionType(\SimpleXMLElement $data)
     {
-        if (!$this->action) {
-            // The extending class probably hasn't specified an "action"
+        if (! $this->action) {
+            // The extending class probably hasn't specified an "action".
             throw new InvalidRequestException();
         }
 

src/Message/AIMCaptureOnlyRequest.php

@@ -2,8 +2,6 @@
 
 namespace Omnipay\AuthorizeNet\Message;
 
-use Omnipay\Common\CreditCard;
-
 /**
  * Authorize.Net AIM Capture Only Request
  */

src/Message/CIMAbstractResponse.php

@@ -155,6 +155,8 @@ public function xml2array(\SimpleXMLElement $xml)
     {
         return json_decode(json_encode($xml), true);
 
+        // Old parser below, just keeping on a hunch.
+
         $arr = array();
 
         foreach ($xml as $element) {

src/Message/CIMCreateCardRequest.php

@@ -26,7 +26,7 @@ public function getData()
     /**
      * Validate card or skip if opaque data is available
      *
-     * @param \SimpleXMLElement $data
+     * @throws \Omnipay\Common\Exception\InvalidCreditCardException
      */
     protected function cardValidate()
     {

src/Message/CIMCreatePaymentProfileRequest.php

@@ -2,8 +2,6 @@
 
 namespace Omnipay\AuthorizeNet\Message;
 
-use Omnipay\Common\CreditCard;
-
 /**
  * Request to create customer payment profile for existing customer.
  */

src/Message/CIMUpdatePaymentProfileRequest.php

@@ -2,8 +2,6 @@
 
 namespace Omnipay\AuthorizeNet\Message;
 
-use Omnipay\Common\CreditCard;
-
 /**
  * Request to create customer payment profile for existing customer.
  */

src/Message/DPMAuthorizeRequest.php

@@ -53,6 +53,8 @@ public function getData()
      * The form may have most of the fields hidden, or may allow the user to change some details -
      * that depends on the use-case.
      * So this method will provide us with an object used to build the form.
+     * @param $data
+     * @return DPMResponse
      */
     public function sendData($data)
     {

src/Message/DPMCompleteRequest.php

@@ -2,8 +2,6 @@
 
 namespace Omnipay\AuthorizeNet\Message;
 
-use Omnipay\Common\Exception\InvalidRequestException;
-
 /**
  * Authorize.Net DPM Complete Authorize Request
  */

src/Message/DPMResponse.php

@@ -72,8 +72,8 @@ class DPMResponse extends AbstractResponse implements RedirectResponseInterface
 
     public function __construct(RequestInterface $request, $data, $postUrl)
     {
-        $this->request = $request;
-        $this->data = $data;
+        parent::__construct($request, $data);
+
         $this->postUrl = $postUrl;
     }
 
@@ -127,6 +127,7 @@ public function getRedirectData()
      * Move a field to the list of hidden form fields.
      * The hidden fields are those we don't want to show the user, but
      * must still be posted.
+     * @param $field_name
      */
     public function hideField($field_name)
     {

src/Message/Query/AIMAbstractQueryRequest.php

@@ -2,16 +2,26 @@
 
 namespace Omnipay\AuthorizeNet\Message\Query;
 
-use Omnipay\AuthorizeNet\Message\AIMAbstractRequest;
-
 /**
  * Authorize.Net AIM Abstract Request
  */
+
+use Omnipay\AuthorizeNet\Message\AIMAbstractRequest;
+use SimpleXMLElement;
+
 abstract class AIMAbstractQueryRequest extends AIMAbstractRequest
 {
     protected $limit = 1000;
     protected $offset = 1;
 
+    /**
+     * Disable validation check on the parent method.
+     */
+    protected function addTransactionType(SimpleXMLElement $data)
+    {
+        // NOOP
+    }
+
     /**
      * Get Limit.
      *

src/Message/Query/AIMPaymentPlanQueryRequest.php

@@ -2,8 +2,6 @@
 
 namespace Omnipay\AuthorizeNet\Message\Query;
 
-use Omnipay\Common\CreditCard;
-
 /**
  * Authorize.Net AIM Authorize Request
  */

src/Message/Query/AIMPaymentPlanQueryResponse.php

@@ -2,8 +2,6 @@
 
 namespace Omnipay\AuthorizeNet\Message\Query;
 
-use Omnipay\AuthorizeNet\Model\CardReference;
-use Omnipay\AuthorizeNet\Model\TransactionReference;
 use Omnipay\Common\Exception\InvalidResponseException;
 use Omnipay\Common\Message\AbstractRequest;
 use Omnipay\Common\Message\AbstractResponse;
@@ -20,7 +18,12 @@ class AIMPaymentPlanQueryResponse extends AbstractQueryResponse
     public function __construct(AbstractRequest $request, $data)
     {
         // Strip out the xmlns junk so that PHP can parse the XML
-        $xml = preg_replace('/<ARBGetSubscriptionRequest[^>]+>/', '<ARBGetSubscriptionRequest>', (string)$data);
+        $xml = preg_replace(
+            '/<ARBGetSubscriptionRequest[^>]+>/',
+            '<ARBGetSubscriptionRequest>',
+            (string)$data
+        );
+
         try {
             $xml = simplexml_load_string($xml, 'SimpleXMLElement', LIBXML_NOWARNING);
         } catch (\Exception $e) {

src/Message/Query/AIMPaymentPlansQueryRequest.php

@@ -2,7 +2,7 @@
 
 namespace Omnipay\AuthorizeNet\Message\Query;
 
-use Omnipay\Common\CreditCard;
+use Omnipay\AuthorizeNet\Message\AIMAbstractRequest;
 
 /**
  * Authorize.Net AIM Authorize Request

src/Message/Query/AIMPaymentPlansQueryResponse.php

@@ -2,8 +2,6 @@
 
 namespace Omnipay\AuthorizeNet\Message\Query;
 
-use Omnipay\AuthorizeNet\Model\CardReference;
-use Omnipay\AuthorizeNet\Model\TransactionReference;
 use Omnipay\Common\Exception\InvalidResponseException;
 use Omnipay\Common\Message\AbstractRequest;
 use Omnipay\Common\Message\AbstractResponse;

src/Message/Query/AbstractQueryResponse.php

@@ -2,9 +2,6 @@
 
 namespace Omnipay\AuthorizeNet\Message\Query;
 
-use Omnipay\AuthorizeNet\Model\CardReference;
-use Omnipay\AuthorizeNet\Model\TransactionReference;
-use Omnipay\Common\Exception\InvalidResponseException;
 use Omnipay\Common\Message\AbstractRequest;
 use Omnipay\Common\Message\AbstractResponse;
 use Omnipay\Omnipay;