phpdoc fixes

Author: barryvdh

src/Omnipay/Common/AbstractGateway.php

@@ -72,11 +72,22 @@ public function __construct(ClientInterface $httpClient = null, HttpRequest $htt
         $this->initialize();
     }
 
+    /**
+     * Get the short name of the Gateway
+     *
+     * @return string
+     */
     public function getShortName()
     {
         return Helper::getGatewayShortName(get_class($this));
     }
 
+    /**
+     * Initialize this gateway with default parameters
+     *
+     * @param  array $parameters
+     * @return $this
+     */
     public function initialize(array $parameters = array())
     {
         $this->parameters = new ParameterBag;
@@ -95,43 +106,72 @@ public function initialize(array $parameters = array())
         return $this;
     }
 
+    /**
+     * @return array
+     */
     public function getDefaultParameters()
     {
         return array();
     }
 
+    /**
+     * @return array
+     */
     public function getParameters()
     {
         return $this->parameters->all();
     }
 
+    /**
+     * @param  string $key
+     * @return mixed
+     */
     protected function getParameter($key)
     {
         return $this->parameters->get($key);
     }
 
+    /**
+     * @param  string $key
+     * @param  mixed  $value
+     * @return $this
+     */
     protected function setParameter($key, $value)
     {
         $this->parameters->set($key, $value);
 
         return $this;
     }
 
+    /**
+     * @return boolean
+     */
     public function getTestMode()
     {
         return $this->getParameter('testMode');
     }
 
+    /**
+     * @param  boolean $value
+     * @return $this
+     */
     public function setTestMode($value)
     {
         return $this->setParameter('testMode', $value);
     }
 
+    /**
+     * @return string
+     */
     public function getCurrency()
     {
         return strtoupper($this->getParameter('currency'));
     }
 
+    /**
+     * @param  string $value
+     * @return $this
+     */
     public function setCurrency($value)
     {
         return $this->setParameter('currency', $value);

src/Omnipay/Common/Message/AbstractRequest.php

@@ -656,13 +656,23 @@ public function setPaymentMethod($value)
         return $this->setParameter('paymentMethod', $value);
     }
 
+    /**
+     * Send the request
+     *
+     * @return ResponseInterface
+     */
     public function send()
     {
         $data = $this->getData();
 
         return $this->sendData($data);
     }
 
+    /**
+     * Get the associated Response.
+     *
+     * @return ResponseInterface
+     */
     public function getResponse()
     {
         if (null === $this->response) {

src/Omnipay/Common/Message/AbstractResponse.php

@@ -67,21 +67,41 @@ public function getRequest()
         return $this->request;
     }
 
+    /**
+     * Is the response successful?
+     *
+     * @return boolean
+     */
     public function isPending()
     {
         return false;
     }
 
+    /**
+     * Does the response require a redirect?
+     *
+     * @return boolean
+     */
     public function isRedirect()
     {
         return false;
     }
 
+    /**
+     * Is the response a transparent redirect?
+     *
+     * @return boolean
+     */
     public function isTransparentRedirect()
     {
         return false;
     }
 
+    /**
+     * Is the transaction cancelled by the user?
+     *
+     * @return boolean
+     */
     public function isCancelled()
     {
         return false;
@@ -97,16 +117,31 @@ public function getData()
         return $this->data;
     }
 
+    /**
+     * Response Message
+     *
+     * @return null|string A response message from the payment gateway
+     */
     public function getMessage()
     {
         return null;
     }
 
+    /**
+     * Response code
+     *
+     * @return null|string A response code from the payment gateway
+     */
     public function getCode()
     {
         return null;
     }
 
+    /**
+     * Gateway Reference
+     *
+     * @return null|string A reference provided by the gateway to represent this transaction
+     */
     public function getTransactionReference()
     {
         return null;
@@ -119,13 +154,18 @@ public function getTransactionReference()
      * redirection page, just call the getRedirectUrl() and getRedirectData() methods directly.
      *
      * @codeCoverageIgnore
+     *
+     * @return void
      */
     public function redirect()
     {
         $this->getRedirectResponse()->send();
         exit;
     }
 
+    /**
+     * @return HttpRedirectResponse
+     */
     public function getRedirectResponse()
     {
         if (!$this instanceof RedirectResponseInterface || !$this->isRedirect()) {

src/Omnipay/Common/Message/RedirectResponseInterface.php

@@ -19,21 +19,29 @@ interface RedirectResponseInterface extends ResponseInterface
 {
     /**
      * Gets the redirect target url.
+     *
+     * @return string
      */
     public function getRedirectUrl();
 
     /**
      * Get the required redirect method (either GET or POST).
+     *
+     * @return string
      */
     public function getRedirectMethod();
 
     /**
      * Gets the redirect form data array, if the redirect method is POST.
+     *
+     * @return array
      */
     public function getRedirectData();
 
     /**
      * Perform the required redirect.
+     *
+     * @return void
      */
     public function redirect();
 }

src/Omnipay/Common/Message/ResponseInterface.php

@@ -46,21 +46,21 @@ public function isCancelled();
     /**
      * Response Message
      *
-     * @return string A response message from the payment gateway
+     * @return null|string A response message from the payment gateway
      */
     public function getMessage();
 
     /**
      * Response code
      *
-     * @return string A response code from the payment gateway
+     * @return null|string A response code from the payment gateway
      */
     public function getCode();
 
     /**
      * Gateway Reference
      *
-     * @return string A reference provided by the gateway to represent this transaction
+     * @return null|string A reference provided by the gateway to represent this transaction
      */
     public function getTransactionReference();
 }