Add PayPal header image url parameter. Closes thephpleague#55

Author: amacneil

src/Omnipay/PayPal/ExpressGateway.php

@@ -30,6 +30,7 @@ public function getDefaultParameters()
         $settings = parent::getDefaultParameters();
         $settings['solutionType'] = array('Sole', 'Mark');
         $settings['landingPage'] = array('Billing', 'Login');
+        $settings['headerImageUrl'] = '';
 
         return $settings;
     }
@@ -54,6 +55,25 @@ public function setLandingPage($value)
         return $this->setParameter('landingPage', $value);
     }
 
+    public function getHeaderImageUrl()
+    {
+        return $this->getParameter('headerImageUrl');
+    }
+
+    /**
+     * Header Image URL (Optional)
+     *
+     * URL for the image you want to appear at the top left of the payment page.
+     * The image has a maximum size of 750 pixels wide by 90 pixels high.
+     * PayPal recommends that you provide an image that is stored on a secure (https) server.
+     * If you do not specify an image, the business name displays.
+     * Character length and limitations: 127 single-byte alphanumeric characters
+     */
+    public function setHeaderImageUrl($value)
+    {
+        return $this->setParameter('headerImageUrl', $value);
+    }
+
     public function authorize(array $parameters = array())
     {
         return $this->createRequest('\Omnipay\PayPal\Message\ExpressAuthorizeRequest', $parameters);

src/Omnipay/PayPal/Message/AbstractRequest.php

@@ -69,6 +69,16 @@ public function setLandingPage($value)
         return $this->setParameter('landingPage', $value);
     }
 
+    public function getHeaderImageUrl()
+    {
+        return $this->getParameter('headerImageUrl');
+    }
+
+    public function setHeaderImageUrl($value)
+    {
+        return $this->setParameter('headerImageUrl', $value);
+    }
+
     protected function getBaseData($method)
     {
         $data = array();

src/Omnipay/PayPal/Message/ExpressAuthorizeRequest.php

@@ -36,6 +36,10 @@ public function getData()
         $data['RETURNURL'] = $this->getReturnUrl();
         $data['CANCELURL'] = $this->getCancelUrl();
 
+        if ($headerImageUrl = $this->getHeaderImageUrl()) {
+            $data['HDRIMG'] = $headerImageUrl;
+        }
+
         if ($card = $this->getCard()) {
             $data['PAYMENTREQUEST_0_SHIPTONAME'] = $card->getName();
             $data['PAYMENTREQUEST_0_SHIPTOSTREET'] = $card->getAddress1();

tests/Omnipay/PayPal/Message/ExpressAuthorizeRequestTest.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of the Omnipay package.
+ *
+ * (c) Adrian Macneil <adrian@adrianmacneil.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Omnipay\PayPal\Message;
+
+use Omnipay\TestCase;
+
+class ExpressAuthorizeRequestTest extends TestCase
+{
+    public function setUp()
+    {
+        parent::setUp();
+
+        $this->request = new ExpressAuthorizeRequest($this->getHttpClient(), $this->getHttpRequest());
+        $this->request->initialize(
+            array(
+                'amount' => 1000,
+                'returnUrl' => 'https://www.example.com/return',
+                'cancelUrl' => 'https://www.example.com/cancel',
+            )
+        );
+    }
+
+    public function testHeaderImageUrl()
+    {
+        $this->request->setHeaderImageUrl('https://www.example.com/image.jpg');
+
+        $data = $this->request->getData();
+        $this->assertEquals('https://www.example.com/image.jpg', $data['HDRIMG']);
+    }
+}