PayPalExpressCheckoutPayment - Code Metrics - sunnysideup/silverstripe-payment_paypal - Measure and Improve Code Quality continuously with Scrutinizer

PayPalExpressCheckoutPayment F
last analyzed 2018-03-20 01:25 UTC

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	482
Duplicated Lines	0 %
Coupling/Cohesion

Components	1
Dependencies	14
Importance

Changes
Metric	Value
wmc	79
lcom	1
cbo	14
dl	0
loc	482
rs	3.3333
c	0
b	0
f	0
14 Methods

Rating	Name	Size	Complexity
A	getCMSFields()	9	2
A	getPaymentFormFields()	12	1
A	getPaymentFormRequirements()	4	1
B	processPayment()	19	5
F	PayPalForm()	102	15
A	populateDefaults()	5	1
D	getTokenURL()	93	13
C	confirmPayment()	77	19
B	getPendingReason()	20	11
B	apiCall()	29	3
A	deformatNVP()	18	3
A	getApiEndpoint()	4	2
A	getPayPalURL()	5	2
A	addDebugInfo()	5	1
How to fix Complexity

<?php


/**
 * PayPal Express Checkout Payment
 * @author Jeremy Shipman jeremy [at] burnbright.net
 * @author Nicolaas [at] sunnysideup.co.nz
 *
 * Developer documentation:
 * Integration guide: https://cms.paypal.com/cms_content/US/en_US/files/developer/PP_ExpressCheckout_IntegrationGuide.pdf
 * API reference: 	  https://cms.paypal.com/us/cgi-bin/?cmd=_render-content&content_ID=developer/howto_api_reference
 * Uses the Name-Value Pair API protocol
 *
 */



class PayPalExpressCheckoutPayment extends EcommercePayment
namespace YourVendor;

class YourClass { }
{
    private static $debug = false;


    private static $db = array(

        'Token' => 'Varchar(30)',
        'PayerID' => 'Varchar(30)',
        'TransactionID' => 'Varchar(30)',
        'AuthorisationCode' => 'Text',
        'Debug' => 'HTMLText'
    );
    private static $logo = "ecommerce/images/paymentmethods/paypal.jpg";

    private static $payment_methods = array();


    //PayPal URLs
    private static $test_API_Endpoint = "https://api-3t.sandbox.paypal.com/nvp";

    private static $test_PAYPAL_URL = "https://www.sandbox.paypal.com/webscr?cmd=_express-checkout&token=";

    private static $API_Endpoint = "https://api-3t.paypal.com/nvp";

    private static $PAYPAL_URL = "https://www.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=";

    private static $privacy_link = "https://www.paypal.com/us/cgi-bin/webscr?cmd=p/gen/ua/policy_privacy-outside";


    //config
    private static $test_mode = true; //on by default

    private static $API_UserName;

    private static $API_Password;

    private static $API_Signature;

    private static $sBNCode = null; // BN Code 	is only applicable for partners

    private static $version = '64';


    //set custom settings
    private static $custom_settings = array(

        //design
        //'HDRIMG' => "http://www.mysite.com/images/logo.jpg", //max size = 750px wide by 90px high, and good to be on secure server

        //'HDRBORDERCOLOR' => 'CCCCCC', //header border

        //'HDRBACKCOLOR' => '00FFFF', //header background

        //'PAYFLOWCOLOR'=> 'AAAAAA' //payflow colour
        //'PAGESTYLE' => //page style set in merchant account settings
        'SOLUTIONTYPE' => 'Sole'//require paypal account, or not. Can be or 'Mark' (required) or 'Sole' (not required)
        //'BRANDNAME'  => 'my site name'//override business name in checkout
        //'CUSTOMERSERVICENUMBER' => '0800 1234 5689'//number to call to resolve payment issues
        //'NOSHIPPING' => 1 //disable showing shipping details

    );

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        foreach (array_keys(self::$db) as $field) {
            $fields->removeFieldFromTab('Root.Main', $field);
            $fields->addFieldToTab('Root.Advanced', LiteralField::create($field.'_debug', '<h2>'.$field.'</h2><pre>'.$this->$field.'</pre>'));
        }
        return $fields;
    }

    public function getPaymentFormFields()
    {
        $logo = '<img src="' . $this->Config()->get("logo") . '" alt="Credit card payments powered by PayPal"/>';
        $privacyLink = '<a href="' . $this->Config()->get("privacy_link") . '" target="_blank" title="Read PayPal\'s privacy policy">' . $logo . '</a><br/>';
        return new FieldList(
            new LiteralField('PayPalInfo', $privacyLink),
            new LiteralField(
                'PayPalPaymentsList',
                $this->renderWith("PaymentMethods")
            )
        );
    }

    public function getPaymentFormRequirements()
    {
        return null;
    }

    //main processing function
    public function processPayment($data, $form)
    {
        //sanity checks for credentials
        if (!$this->Config()->get("API_UserName") || !$this->Config()->get("API_Password") || !$this->Config()->get("API_Signature")) {
            user_error('You are attempting to make a payment without the necessary credentials set', E_USER_ERROR);
        }
        $data = $this->Order()->BillingAddress()->toMap();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        $paymenturl = $this->getTokenURL($this->Amount->Amount, $this->Amount->Currency, $data);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->Status = "Incomplete";
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->write();
        if ($paymenturl) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            Controller::curr()->redirect($paymenturl); //redirect to payment gateway
            return EcommercePayment_Processing::create();
        }
        $this->Message = _t('PayPalExpressCheckoutPayment.COULDNOTBECONTACTED', "PayPal could not be contacted");
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->Status = 'Failure';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->write();
        return EcommercePayment_Failure::create($this->Message);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     *
     * depracated
     */
    public function PayPalForm()

    {
        user_error("This form is no longer used.");
        Requirements::javascript(THIRDPARTY_DIR . '/jquery/jquery.js');

        // 1) Main Information
        $fields = '';
        $order = $this->Order();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        $items = $order->Items();
        $member = $order->Member();

        // 2) Main Settings

        $url = $this->Config()->get("test_mode") ? $this->Config()->get("test_url") : $this->Config()->get("url");
        $inputs['cmd'] = '_cart';
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $inputs['upload'] = '1';

        // 3) Items Informations

        $cpt = 0;
        foreach ($items as $item) {
            $inputs['item_name_' . ++$cpt] = $item->TableTitle();
            // item_number is unnecessary
            $inputs['amount_' . $cpt] = $item->UnitPrice();
            $inputs['quantity_' . $cpt] = $item->Quantity;
        }

        // 4) Payment Informations And Authorisation Code

        $inputs['business'] = $this->Config()->get("test_mode") ? $this->Config()->get("test_account_email") : $this->Config()->get("account_email");
        $inputs['custom'] = $this->ID . '-' . $this->AuthorisationCode;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        // Add Here The Shipping And/Or Taxes
        $inputs['currency_code'] = $this->Currency;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        // 5) Redirection Informations

        $inputs['cancel_return'] = Director::absoluteBaseURL() . PayPalExpressCheckoutPayment_Handler::cancel_link($inputs['custom']);

        $inputs['return'] = Director::absoluteBaseURL() . PayPalExpressCheckoutPayment_Handler::complete_link();

        $inputs['rm'] = '2';
        // Add Here The Notify URL

        // 6) PayPal Pages Style Optional Informations

        if (self:: $continue_button_text) {
            $inputs['cbt'] = $this->Config()->get("continue_button_text");
        }

        if ($this->Config()->get("header_image_url")) {
            $inputs['cpp_header_image'] = urlencode($this->Config()->get("header_image_url"));
        }
        if ($this->Config()->get("header_back_color")) {
            $inputs['cpp_headerback_color'] = $this->Config()->get("header_back_color");
        }
        if ($this->Config()->get("header_border_color")) {
            $inputs['cpp_headerborder_color'] = $this->Config()->get("header_border_color");
        }
        if ($this->Config()->get("payflow_color")) {
            $inputs['cpp_payflow_color'] = $this->Config()->get("payflow_color");
        }
        if ($this->Config()->get("back_color")) {
            $inputs['cs'] = $this->Config()->get("back_color");
        }
        if ($this->Config()->get("image_url")) {
            $inputs['image_url'] = urlencode($this->Config()->get("image_url"));
        }
        if ($this->Config()->get("page_style")) {
            $inputs['page_style'] = $this->Config()->get("page_style");
        }

        // 7) Prepopulating Customer Informations
        $billingAddress = $order->BillingAddress();
        $inputs['first_name'] = $billingAddress->FirstName;
        $inputs['last_name'] = $billingAddress->Surname;
        $inputs['address1'] = $billingAddress->Address;
        $inputs['address2'] = $billingAddress->Address2;
        $inputs['city'] = $billingAddress->City;
        $inputs['zip'] = $billingAddress->PostalCode;
        $inputs['state'] = $billingAddress->Region()->Code;
        $inputs['country'] = $billingAddress->Country;
        $inputs['email'] = $member->Email;

        // 8) Form Creation
        if (is_array($inputs) && count($inputs)) {
            foreach ($inputs as $name => $value) {
                $ATT_value = Convert::raw2att($value);
                $fields .= "<input type=\"hidden\" name=\"$name\" value=\"$ATT_value\" />";
            }
        }

        return <<<HTML
            <form id="PaymentForm" method="post" action="$url">
                $fields
                <input type="submit" value="Submit" />
            </form>
            <script type="text/javascript">
                jQuery(document).ready(function() {
                    jQuery("input[type='submit']").hide();
                    jQuery('#PaymentForm').submit();
                });
            </script>
HTML;
    }

    public function populateDefaults()
    {
        parent::populateDefaults();
        $this->AuthorisationCode = md5(uniqid(rand(), true));
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }




    /**
     * Requests a Token url, based on the provided Name-Value-Pair fields
     * See docs for more detail on these fields:
     * https://cms.paypal.com/us/cgi-bin/?cmd=_render-content&content_ID=developer/e_howto_api_nvp_r_SetExpressCheckout
     *
     * Note: some of these values will override the paypal merchant account settings.
     * Note: not all fields are listed here.
     */
    protected function getTokenURL($paymentAmount, $currencyCodeType, $extradata = array())
    {
        $data = array(
            //payment info
            'PAYMENTREQUEST_0_AMT' => $paymentAmount,
            'PAYMENTREQUEST_0_CURRENCYCODE' => $currencyCodeType, //TODO: check to be sure all currency codes match the SS ones
            //TODO: include individual costs: shipping, shipping discount, insurance, handling, tax??
            //'PAYMENTREQUEST_0_ITEMAMT' => //item(s)
            //'PAYMENTREQUEST_0_SHIPPINGAMT' //shipping
            //'PAYMENTREQUEST_0_SHIPDISCAMT' //shipping discount
            //'PAYMENTREQUEST_0_HANDLINGAMT' //handling
            //'PAYMENTREQUEST_0_TAXAMT' //tax
            //'PAYMENTREQUEST_0_INVNUM' => $this->PaidObjectID //invoice number

            //'PAYMENTREQUEST_0_TRANSACTIONID' //Transaction id
            //'PAYMENTREQUEST_0_DESC' => //description
            //'PAYMENTREQUEST_0_NOTETEXT' => //note to merchant
            //'PAYMENTREQUEST_0_PAYMENTACTION' => , //Sale, Order, or Authorization

            //'PAYMENTREQUEST_0_PAYMENTREQUESTID'
            //return urls
            'RETURNURL' => PayPalExpressCheckoutPayment_Handler::return_link(),
            'CANCELURL' => PayPalExpressCheckoutPayment_Handler::cancel_link(),
            //'PAYMENTREQUEST_0_NOTIFYURL' => //Instant payment notification
            //'CALLBACK'
            //'CALLBACKTIMEOUT'
            //shipping display
            //'REQCONFIRMSHIPPING' //require that paypal account address be confirmed
            'NOSHIPPING' => 1, //show shipping fields, or not 0 = show shipping, 1 = don't show shipping, 2 = use account address, if none passed
            //'ALLOWOVERRIDE' //display only the provided address, not the one stored in paypal
            //TODO: Probably overkill, but you can even include the prices,qty,weight,tax etc for individual sale items
            //other settings
            //'LOCALECODE' => //locale, or default to US
            'LANDINGPAGE' => 'Billing' //can be 'Billing' or 'Login'
        );

        if (!isset($extradata['Name'])) {
            $arr =  array();
            if (isset($extradata['FirstName'])) {
                $arr[] = $extradata['FirstName'];
            }
            if (isset($extradata['MiddleName'])) {
                $arr[] = $extradata['MiddleName'];
            }
            if (isset($extradata['Surname'])) {
                $arr[] = $extradata['Surname'];
            }
            $extradata['Name'] = implode(' ', $arr);
        }
        $extradata["OrderID"] = SiteConfig::current_site_config()->Title." ".$this->Order()->getTitle();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        //add member & shipping fields, etc ...this will pre-populate the paypal login / create account form
        foreach (array(
            'Email' => 'EMAIL',
            'Name' => 'PAYMENTREQUEST_0_SHIPTONAME',
            'Address' => 'PAYMENTREQUEST_0_SHIPTOSTREET',
            'Address2' => 'PAYMENTREQUEST_0_SHIPTOSTREET2',
            'City' => 'PAYMENTREQUEST_0_SHIPTOCITY',
            'PostalCode' => 'PAYMENTREQUEST_0_SHIPTOZIP',
            'Region' => 'PAYMENTREQUEST_0_SHIPTOPHONENUM',
            'Phone' => 'PAYMENTREQUEST_0_SHIPTOPHONENUM',
            'Country' => 'PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE',
            'OrderID' => 'PAYMENTREQUEST_0_DESC'
        ) as $field => $val) {
            if (isset($extradata[$field])) {
                $data[$val] = $extradata[$field];
            } elseif ($this->$field) {
                $data[$val] = $this->$field;
            }
        }
        //set design settings
        $data = array_merge($this->Config()->get("custom_settings"), $data);
        $response = $this->apiCall('SetExpressCheckout', $data);
        if (Config::inst()->get("PayPalExpressCheckoutPayment", "debug")) {
            $this->addDebugInfo("RESPONSE: ".print_r($response, 1));
            $debugmessage = "PayPal Debug:" .
                "\nMode: $mode".
function someFunction() {
    $x = 5;
    echo $x;
}
                "\nAPI url: ".$this->getApiEndpoint().
                "\nRedirect url: ".$this->getPayPalURL($response['TOKEN']).
                "\nUsername: " .$this->Config()->get("API_UserName").
                "\nPassword: " .$this->Config()->get("API_Password").
                "\nSignature: ".$this->Config()->get("API_Signature").
                "\nRequest Data: ".print_r($data, true).
                "\nResponse: ".print_r($response, true);
            $this->addDebugInfo("DEBUG MESSAGE: ".$debugmessage);
        }
        if (!isset($response['ACK']) ||  !(strtoupper($response['ACK']) == "SUCCESS" || strtoupper($response['ACK']) == "SUCCESSWITHWARNING")) {
            $mode = ($this->Config()->get("test_mode") === true) ? "test" : "live";
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            return null;
        }
        //get and save token for later
        $token = $response['TOKEN'];
        $this->Token = $token;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->write();
        return $this->getPayPalURL($token);
    }

    /**
     * see https://cms.paypal.com/us/cgi-bin/?cmd=_render-content&content_ID=developer/e_howto_api_nvp_r_DoExpressCheckoutPayment
     */
    public function confirmPayment()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $data = array(
            'PAYERID' => $this->PayerID,
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            'TOKEN' => $this->Token,
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            'PAYMENTREQUEST_0_PAYMENTACTION' => "Sale",
            'PAYMENTREQUEST_0_AMT' => $this->Amount->Amount,
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            'PAYMENTREQUEST_0_CURRENCYCODE' => $this->Amount->Currency,
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            'IPADDRESS' => urlencode($_SERVER['SERVER_NAME'])
        );
        $response = $this->apiCall('DoExpressCheckoutPayment', $data);
        if (!isset($response['ACK']) ||  !(strtoupper($response['ACK']) == "SUCCESS" || strtoupper($response['ACK']) == "SUCCESSWITHWARNING")) {
            return null;
        }
        if (isset($response["PAYMENTINFO_0_TRANSACTIONID"])) {
            //' Unique transaction ID of the payment. Note:  If the PaymentAction of the request was Authorization or Order, this value is your AuthorizationID for use with the Authorization & Capture APIs.
            $this->TransactionID    = $response["PAYMENTINFO_0_TRANSACTIONID"];
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }
        //$transactionType 		= $response["PAYMENTINFO_0_TRANSACTIONTYPE"]; //' The type of transaction Possible values: l  cart l  express-checkout

        //$paymentType			= $response["PAYMENTTYPE"];  	//' Indicates whether the payment is instant or delayed. Possible values: l  none l  echeck l  instant

        //$orderTime 				= $response["ORDERTIME"];  		//' Time/date stamp of payment

        //TODO: should these be updated like this?
        //$this->Amount->Amount	= $response["AMT"];  			//' The final amount charged, including any shipping and taxes from your Merchant Profile.

        //$this->Amount->Currency= $response["CURRENCYCODE"];  	//' A three-character currency code for one of the currencies listed in PayPay-Supported Transactional Currencies. Default: USD.

        //TODO: store this extra info locally?
        //$feeAmt					= $response["FEEAMT"];  		//' PayPal fee amount charged for the transaction

        //$settleAmt				= $response["SETTLEAMT"];  		//' Amount deposited in your PayPal account after a currency conversion.

        //$taxAmt					= $response["TAXAMT"];  		//' Tax charged on the transaction.

        //$exchangeRate			= $response["EXCHANGERATE"];  	//' Exchange rate if a currency conversion occurred. Relevant only if your are billing in their non-primary currency. If the customer chooses to pay with a currency other than the non-primary currency, the conversion occurs in the customer's account.

        if (isset($response["PAYMENTINFO_0_PAYMENTSTATUS"])) {
            switch (strtoupper($response["PAYMENTINFO_0_PAYMENTSTATUS"])) {
                case "PROCESSED":
                case "COMPLETED":
                    $this->Status = 'Success';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    $this->Message = _t('PayPalExpressCheckoutPayment.SUCCESS', "The payment has been completed, and the funds have been successfully transferred");
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    break;
                case "EXPIRED":
                    $this->Message = _t('PayPalExpressCheckoutPayment.AUTHORISATION', "The authorization period for this payment has been reached");
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    $this->Status = 'Failure';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    break;
                case "DENIED":
                    $this->Message = _t('PayPalExpressCheckoutPayment.FAILURE', "Payment was denied");
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    $this->Status = 'Failure';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    break;
                case "REVERSED":
                    $this->Status = 'Failure';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    break;
                case "VOIDED":
                    $this->Message = _t('PayPalExpressCheckoutPayment.VOIDED', "An authorization for this transaction has been voided.");
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    $this->Status = 'Failure';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    break;
                case "FAILED":
                    $this->Status = 'Failure';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    break;
                case "CANCEL-REVERSAL": // A reversal has been canceled; for example, when you win a dispute and the funds for the reversal have been returned to you.
                    break;
                case "IN-PROGRESS":
                    $this->Message = _t('PayPalExpressCheckoutPayment.INPROGRESS', "The transaction has not terminated");//, e.g. an authorization may be awaiting completion.";
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    break;
                case "PARTIALLY-REFUNDED":
                    $this->Message = _t('PayPalExpressCheckoutPayment.PARTIALLYREFUNDED', "The payment has been partially refunded.");
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    break;
                case "PENDING":
                    $this->Message = _t('PayPalExpressCheckoutPayment.PENDING', "The payment is pending.");
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    if (isset($response["PAYMENTINFO_0_PENDINGREASON"])) {
                        $this->Message .= " ".$this->getPendingReason($response["PAYMENTINFO_0_PENDINGREASON"]);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    }
                    break;
                case "REFUNDED":
                    $this->Message = _t('PayPalExpressCheckoutPayment.REFUNDED', "Payment refunded.");
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    break;
                default:
            }
        }
        //$reasonCode		= $response["REASONCODE"];

        $this->write();
    }

    protected function getPendingReason($reason)
    {
        switch ($reason) {
            case "address":
                return _t('PayPalExpressCheckoutPayment.PENDING.ADDRESS', "A confirmed shipping address was not provided.");
            case "authorization":
                return _t('PayPalExpressCheckoutPayment.PENDING.AUTHORISATION', "Payment has been authorised, but not settled.");
            case "echeck":
                return _t('PayPalExpressCheckoutPayment.PENDING.ECHECK', "eCheck has not cleared.");
            case "intl":
                return _t('PayPalExpressCheckoutPayment.PENDING.INTERNATIONAL', "International: payment must be accepted or denied manually.");
            case "multicurrency":
                return _t('PayPalExpressCheckoutPayment.PENDING.MULTICURRENCY', "Multi-currency: payment must be accepted or denied manually.");
            case "order":
            case "paymentreview":
            case "unilateral":
            case "verify":
            case "other":
        }
    }

    /**
     * Handles actual communication with API server.
     */
    protected function apiCall($method, $data = array())
    {
        $this->addDebugInfo('---------------------------------------');
        $this->addDebugInfo('---------------------------------------');
        $this->addDebugInfo('---------------------------------------');
        $postfields = array(
            'METHOD' => $method,
            'VERSION' => $this->Config()->get("version"),
            'USER' => $this->Config()->get("API_UserName"),
            'PWD'=> $this->Config()->get("API_Password"),
            'SIGNATURE' => $this->Config()->get("API_Signature"),
            'BUTTONSOURCE' => $this->Config()->get("sBNCode")
        );
        if (Config::inst()->get("PayPalExpressCheckoutPayment", "debug")) {
            $this->addDebugInfo("STANDARD POSTING FIELDS ....  //// : ".print_r($postfields, 1));
            $this->addDebugInfo("ADDITIONAL POSTING FIELDS ....  //// : ".print_r($data, 1));
            $this->addDebugInfo("SENDING TO ....  //// : ".print_r($this->getApiEndpoint(), 1));
        }
        $postfields = array_merge($postfields, $data);
        //Make POST request to Paypal via RESTful service
        $rs = new RestfulService($this->getApiEndpoint(), 0); //REST connection that will expire immediately
        $rs->httpHeader('Accept: application/xml');
        $rs->httpHeader('Content-Type: application/x-www-form-urlencoded');
        $response = $rs->request('', 'POST', http_build_query($postfields));
        if (Config::inst()->get("PayPalExpressCheckoutPayment", "debug")) {
            $this->addDebugInfo('RESPONSE ....  //// : '.print_r($response, 1));
        }
        return $this->deformatNVP($response->getBody());
    }

    protected function deformatNVP($nvpstr)
    {
        $intial = 0;
        $nvpArray = array();
        while (strlen($nvpstr)) {
            //postion of Key
            $keypos= strpos($nvpstr, '=');
            //position of value
            $valuepos = strpos($nvpstr, '&') ? strpos($nvpstr, '&'): strlen($nvpstr);
            /*getting the Key and Value values and storing in a Associative Array*/
            $keyval=substr($nvpstr, $intial, $keypos);
            $valval=substr($nvpstr, $keypos+1, $valuepos-$keypos-1);
            //decoding the respose
            $nvpArray[urldecode($keyval)] =urldecode($valval);
            $nvpstr=substr($nvpstr, $valuepos+1, strlen($nvpstr));
        }
        return $nvpArray;
    }

    protected function getApiEndpoint()

    {
        return ($this->Config()->get("test_mode") === true) ? $this->Config()->get("test_API_Endpoint") : $this->Config()->get("API_Endpoint");
    }

    protected function getPayPalURL($token)
    {
        $url = ($this->Config()->get("test_mode") === true) ? $this->Config()->get("test_PAYPAL_URL") : $this->Config()->get("PAYPAL_URL");
        return $url.$token.'&useraction=commit'; //useraction=commit ensures the payment is confirmed on PayPal, and not on a merchant confirm page.
    }


    protected function addDebugInfo($msg)
    {
        $this->Debug .= "---------//------------\n\n".$msg;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->write();
    }
}

/**
 * Handler for responses from the PayPal site
 */
class PayPalExpressCheckoutPayment_Handler extends Controller
namespace YourVendor;

class YourClass { }
{
    private static $url_segment = 'paypalexpresscheckoutpayment_handler';


    protected $payment = null; //only need to get this once

    private static $allowed_actions = array(

        'confirm',
        'cancel'
    );

    public function Link($action = null)
    {
        return Controller::join_links(
            Director::baseURL(),
            $this->Config()->get("url_segment"),
            $action
        );
    }

    public function payment()

    {
        if ($this->payment) {
            return $this->payment;
        } elseif ($token = Controller::getRequest()->getVar('token')) {
            $payment =  PayPalExpressCheckoutPayment::get()
                ->filter(
                    array(
                        "Token" => $token,
                        "Status" => "Incomplete"
                    )
                )
                ->first();
            $this->payment = $payment;
            $this->payment->init();
            return $this->payment;
        }
        return null;
    }

    public function confirm($request)

    {
        //TODO: pretend the user confirmed, and skip straight to results. (check that this is allowed)
        //TODO: get updated shipping details from paypal??
        if ($payment = $this->payment()) {
            if ($pid = Controller::getRequest()->getVar('PayerID')) {
                $payment->PayerID = $pid;
                $payment->write();
                $payment->confirmPayment();
            }
        } else {
if (rand(1, 6) > 3) {
print "Check failed";
} else {
    //print "Check succeeded";
}
            //something went wrong?	..perhaps trying to pay for a payment that has already been processed
        }
        $this->doRedirect();
        return;
    }

    public function cancel($request)

    {
        if ($payment = $this->payment()) {
            //TODO: do API call to gather further information
            $payment->Status = "Failure";
            $payment->Message = _t('PayPalExpressCheckoutPayment.USERCANCELLED', "User cancelled");
            $payment->write();
        }
        $this->doRedirect();
        return;
    }

    protected function doRedirect()
    {
        $payment = $this->payment();
        if ($payment && $obj = $payment->PaidObject()) {
            $this->redirect($obj->Link());
            return;
        }
        $this->redirect(Director::absoluteURL('home', true)); //TODO: make this customisable in Payment_Controllers
        return;
    }

    public static function return_link()
    {
        return Director::absoluteURL(Config::inst()->get("PayPalExpressCheckoutPayment_Handler", "url_segment"), true)."/confirm/";
    }

    public static function cancel_link()
    {
        return Director::absoluteURL(Config::inst()->get("PayPalExpressCheckoutPayment_Handler", "url_segment"), true)."/cancel/";
    }
}

sunnysideup / silverstripe-payment_paypal

PayPalExpressCheckoutPayment F last analyzed 2018-03-20 01:25 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

14 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like

PayPalExpressCheckoutPayment F
last analyzed 2018-03-20 01:25 UTC
