Viewing file:  ExpressAuthorizeRequest.php (6.68 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
namespace Omnipay\PayPal\Message;
use Omnipay\Common\Exception\InvalidRequestException;
use Omnipay\PayPal\Support\InstantUpdateApi\ShippingOption;
use Omnipay\PayPal\Support\InstantUpdateApi\BillingAgreement;
/**
* PayPal Express Authorize Request
*/
class ExpressAuthorizeRequest extends AbstractRequest
{
const DEFAULT_CALLBACK_TIMEOUT = 5;
public function setCallback($callback)
{
return $this->setParameter('callback', $callback);
}
public function getCallback()
{
return $this->getParameter('callback');
}
public function setCallbackTimeout($callbackTimeout)
{
return $this->setParameter('callbackTimeout', $callbackTimeout);
}
public function getCallbackTimeout()
{
return $this->getParameter('callbackTimeout');
}
/**
* @param ShippingOption[] $data
*/
public function setShippingOptions($data)
{
$this->setParameter('shippingOptions', $data);
}
/**
* @return ShippingOption[]
*/
public function getShippingOptions()
{
return $this->getParameter('shippingOptions');
}
/**
* @param BillingAgreement $data
*/
public function setBillingAgreement($data)
{
$this->setParameter('billingAgreement', $data);
}
/**
* @return BillingAgreement
*/
public function getBillingAgreement()
{
return $this->getParameter('billingAgreement');
}
protected function validateCallback()
{
$callback = $this->getCallback();
if (!empty($callback)) {
$shippingOptions = $this->getShippingOptions();
if (empty($shippingOptions)) {
throw new InvalidRequestException(
'When setting a callback for the Instant Update API you must set shipping options'
);
} else {
$hasDefault = false;
foreach ($shippingOptions as $shippingOption) {
if ($shippingOption->isDefault()) {
$hasDefault = true;
continue;
}
}
if (!$hasDefault) {
throw new InvalidRequestException(
'One of the supplied shipping options must be set as default'
);
}
}
}
}
public function getData()
{
$this->validate('amount', 'returnUrl', 'cancelUrl');
$this->validateCallback();
$data = $this->getBaseData();
$data['METHOD'] = 'SetExpressCheckout';
$data['PAYMENTREQUEST_0_PAYMENTACTION'] = 'Authorization';
$data['PAYMENTREQUEST_0_AMT'] = $this->getAmount();
$data['PAYMENTREQUEST_0_CURRENCYCODE'] = $this->getCurrency();
$data['PAYMENTREQUEST_0_INVNUM'] = $this->getTransactionId();
$data['PAYMENTREQUEST_0_DESC'] = $this->getDescription();
// pp express specific fields
$data['SOLUTIONTYPE'] = $this->getSolutionType();
$data['LANDINGPAGE'] = $this->getLandingPage();
$data['RETURNURL'] = $this->getReturnUrl();
$data['CANCELURL'] = $this->getCancelUrl();
$data['HDRIMG'] = $this->getHeaderImageUrl();
$data['BRANDNAME'] = $this->getBrandName();
$data['NOSHIPPING'] = $this->getNoShipping();
$data['ALLOWNOTE'] = $this->getAllowNote();
$data['ADDROVERRIDE'] = $this->getAddressOverride();
$data['LOGOIMG'] = $this->getLogoImageUrl();
$data['CARTBORDERCOLOR'] = $this->getBorderColor();
$data['LOCALECODE'] = $this->getLocaleCode();
$data['CUSTOMERSERVICENUMBER'] = $this->getCustomerServiceNumber();
$callback = $this->getCallback();
if (!empty($callback)) {
$data['CALLBACK'] = $callback;
// callback timeout MUST be included and > 0
$timeout = $this->getCallbackTimeout();
$data['CALLBACKTIMEOUT'] = $timeout > 0 ? $timeout : self::DEFAULT_CALLBACK_TIMEOUT;
// if you're using a callback you MUST set shipping option(s)
$shippingOptions = $this->getShippingOptions();
if (!empty($shippingOptions)) {
foreach ($shippingOptions as $index => $shipping) {
$data['L_SHIPPINGOPTIONNAME' . $index] = $shipping->getName();
$data['L_SHIPPINGOPTIONAMOUNT' . $index] = number_format($shipping->getAmount(), 2);
$data['L_SHIPPINGOPTIONISDEFAULT' . $index] = $shipping->isDefault() ? '1' : '0';
if ($shipping->hasLabel()) {
$data['L_SHIPPINGOPTIONLABEL' . $index] = $shipping->getLabel();
}
}
}
}
$data['MAXAMT'] = $this->getMaxAmount();
$data['PAYMENTREQUEST_0_TAXAMT'] = $this->getTaxAmount();
$data['PAYMENTREQUEST_0_SHIPPINGAMT'] = $this->getShippingAmount();
$data['PAYMENTREQUEST_0_HANDLINGAMT'] = $this->getHandlingAmount();
$data['PAYMENTREQUEST_0_SHIPDISCAMT'] = $this->getShippingDiscount();
$data['PAYMENTREQUEST_0_INSURANCEAMT'] = $this->getInsuranceAmount();
$data['PAYMENTREQUEST_0_SELLERPAYPALACCOUNTID'] = $this->getSellerPaypalAccountId();
$card = $this->getCard();
if ($card) {
$data['PAYMENTREQUEST_0_SHIPTONAME'] = $card->getName();
$data['PAYMENTREQUEST_0_SHIPTOSTREET'] = $card->getAddress1();
$data['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $card->getAddress2();
$data['PAYMENTREQUEST_0_SHIPTOCITY'] = $card->getCity();
$data['PAYMENTREQUEST_0_SHIPTOSTATE'] = $card->getState();
$data['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $card->getCountry();
$data['PAYMENTREQUEST_0_SHIPTOZIP'] = $card->getPostcode();
$data['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $card->getPhone();
$data['EMAIL'] = $card->getEmail();
}
$billingAgreement = $this->getBillingAgreement();
if ($billingAgreement) {
$data['L_BILLINGTYPE0'] = $billingAgreement->getType();
$data['L_BILLINGAGREEMENTDESCRIPTION0'] = $billingAgreement->getDescription();
if ($billingAgreement->hasPaymentType()) {
$data['L_PAYMENTTYPE0'] = $billingAgreement->getPaymentType();
}
if ($billingAgreement->hasCustomAnnotation()) {
$data['L_BILLINGAGREEMENTCUSTOM0'] = $billingAgreement->getCustomAnnotation();
}
}
$data = array_merge($data, $this->getItemData());
return $data;
}
protected function createResponse($data)
{
return $this->response = new ExpressAuthorizeResponse($this, $data);
}
}
|