EwayPayment - Code Metrics - sunnysideup/silverstripe-payment_eway - Measure and Improve Code Quality continuously with Scrutinizer

EwayPayment A
last analyzed 2018-03-20 01:24 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	289
Duplicated Lines	4.84 %

Coupling/Cohesion

Components	1
Dependencies	10

Importance

Changes

Metric	Value
wmc	24
lcom	1
cbo	10
dl	14
loc	289
rs	10
c	0
b	0
f	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getPaymentFormFields()	0	20	4
A	getPaymentFormRequirements()	0	4	1
C	processPayment()	0	36	8
B	EwayURL()	7	56	7
A	EwayForm()	0	21	1
A	EwayConfirmationURL()	7	12	2
A	populateDefaults()	0	5	1

How to fix Duplicated Code

<?php

/**
 * @see http://www.eway.com.au/developers/api/shared-payments
 * @see http://www.eway.com.au/docs/api-documentation/sharedpaymentpagedoc.pdf
 * http://www.eway.com.au/developers/resources/response-codes
 *
 *
 * test CC:
 * 4444333322221111
 * any expiry, name, etc...
 *
 */
class EwayPayment extends EcommercePayment
namespace YourVendor;

class YourClass { }
{
    private static $db = array(

        'AuthorisationCode' => 'Text'
    );

    // Eway Information

    private static $privacy_link = 'https://www.eway.com.au/Company/About/Privacy.aspx';


    private static $logo = '/payment_eway/images/eway.png';


    // Company Information

    private static $page_title = 'Your Title';


    private static $company_name = 'Your Company Name';


    private static $payment_explanation = 'Your payment will be processed by the eWay payment processing site.';


    /**
     * e.g. /themes/mytheme/images/myimage.png
     * make sure the location is SSL if you add it
     * @var String
     */
    private static $company_logo = 'Your company Logo file location';


    // URLs

    private static $url = 'https://au.ewaygateway.com/Request';



    private static $confirmation_url = 'https://au.ewaygateway.com/Result';


    // Test Mode

    private static $test_customer_id = '87654321';


    private static $test_customer_username = 'TestAccount';


    /**
     * NB: this is a string... anything will divert to LIVE
     * unless it is set to "yes"
     * @var String
     */
    private static $test_mode = 'no';


    // Account Information

    private static $customer_id;


    private static $customer_username;


    // Credit Cards

    private static $credit_cards = array(

        //'Visa' => 'payment/images/payments/methods/visa.jpg',

        //'MasterCard' => 'payment/images/payments/methods/mastercard.jpg',

        //'American Express' => 'payment/images/payments/methods/american-express.gif',

        //'Dinners Club' => 'payment/images/payments/methods/dinners-club.jpg',

        //'JCB' => 'payment/images/payments/methods/jcb.jpg'
    );


    protected $testCodes = array(
"0" => " --- SELECT RESPONSE TYPE ---",
"00" => "Transaction Approved approved",
"01" => "Refer to Issuer",
"02" => "Refer to Issuer, special",
"03" => "No Merchant",
"04" => "Pick Up Card",
"05" => "Do Not Honour",
"06" => "Error",
"07" => "Pick Up Card, Special",
"08" => "Honour With Identification approved",
"09" => "Request In Progress",
"10" => "Approved For Partial Amount approved",
"11" => "Approved, VIP approved",
"12" => "Invalid Transaction",
"13" => "Invalid Amount",
"14" => "Invalid Card Number",
"15" => "No Issuer",
"16" => "Approved, Update Track 3 approved",
"19" => "Re-enter Last Transaction",
"21" => "No Action Taken",
"22" => "Suspected Malfunction",
"23" => "Unacceptable Transaction Fee",
"25" => "Unable to Locate Record On File",
"30" => "Format Error",
"31" => "Bank Not Supported By Switch",
"33" => "Expired Card, Capture",
"34" => "Suspected Fraud, Retain Card",
"35" => "Card Acceptor, Contact Acquirer, Retain Card",
"36" => "Restricted Card, Retain Card",
"37" => "Contact Acquirer Security Department, Retain Card",
"38" => "PIN Tries Exceeded, Capture",
"39" => "No Credit Account",
"40" => "Function Not Supported",
"41" => "Lost Card",
"42" => "No Universal Account",
"43" => "Stolen Card",
"44" => "No Investment Account",
"51" => "Insufficient Funds",
"52" => "No Cheque Account",
"53" => "No Savings Account",
"54" => "Expired Card",
"55" => "Incorrect PIN",
"56" => "No Card Record",
"57" => "Function Not Permitted to Cardholder",
"58" => "Function Not Permitted to Terminal",
"59" => "Suspected Fraud",
"60" => "Acceptor Contact Acquirer",
"61" => "Exceeds Withdrawal Limit",
"62" => "Restricted Card",
"63" => "Security Violation",
"64" => "Original Amount Incorrect",
"66" => "Acceptor Contact Acquirer, Security",
"67" => "Capture Card",
"75" => "PIN Tries Exceeded",
"82" => "CVV Validation Error",
"90" => "Cutoff In Progress",
"91" => "Card Issuer Unavailable",
"92" => "Unable To Route Transaction",
"93" => "Cannot Complete, Violation Of The Law",
"94" => "Duplicate Transaction",
"96" => "System Error"
 );

    public function getPaymentFormFields()
    {
        $logo = '<img src="' . $this->config()->get('logo') . '" alt="Credit card payments powered by eWAY"/>';
        $privacyLink = '<a href="' . $this->config()->get('privacy_link') . '" target="_blank" title="Read eWAY\'s privacy policy">' . $logo . '</a>';
        $paymentsList = '';
        if ($cards = $this->config()->get('credit_cards')) {
            foreach ($cards as $name => $image) {
                $paymentsList .= '<img src="' . $image . '" alt="' . $name . '"/>';
            }
        }
        $paymentsList .= "<p>".$this->Config()->get("payment_explanation")."</p>";
        $fields = new FieldList(
            new LiteralField('EwayInfo', $privacyLink),
            new LiteralField('EwayPaymentsList', $paymentsList)
        );
        if (Director::isDev()) {
            $fields->push(new DropdownField("PaymentTypeTest", "Required outcome", $this->testCodes));
        }
        return $fields;
    }

    public function getPaymentFormRequirements()
    {
        return null;
    }

    public function processPayment($data, $form)
    {

        // 1) Get secured Eway url

        $url = $this->EwayURL();
        $response = file_get_contents($url);
        if ($response) {
            $response = Convert::xml2array($response);
            if (isset($response['Result']) && $response['Result'] == 'True' && isset($response['URI']) && $response['URI']) {

                // 2) Redirect to the secured Eway url

                $page = new Page();

                $page->Title = 'Redirection to eWAY...';
                $page->Logo = '<img src="' . $this->config()->get('logo') . '" alt="Payments powered by eWAY"/>';
                $page->Form = $this->EwayForm($response['URI']);

                $controller = new Page_Controller($page);

                $form = $controller->renderWith('PaymentProcessingPage');

                return EcommercePayment_Processing::create($form);
            }
        }

        $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.");
        }
    }

}
        if ($response && isset($response['Error'])) {
            $this->Message = $response['Error'];
<?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->redirectToOrder();
    }

    public function EwayURL()
// 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);
    }
}
    {

        // 1) Main Informations

        $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();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        // 2) Main Settings

        if ($this->config()->get('test_mode') == 'yes') {

            $inputs['CustomerID'] = $this->config()->get('test_customer_id');
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
            $inputs['UserName'] = $this->config()->get('test_customer_username');
        } else {
            $inputs['CustomerID'] = $this->config()->get('customer_id');
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
            $inputs['UserName'] = $this->config()->get('customer_username');
        }
        if ($this->config()->get('test_mode') == 'yes' && isset($_REQUEST["PaymentTypeTest"])) {
            $amount = round($this->Amount->getAmount())+(intval($_REQUEST["PaymentTypeTest"])/100);
<?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.");
        }
    }

}
        } else {
            $amount = $this->Amount->getAmount();
<?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.");
        }
    }

}
        }
        $inputs['Amount'] = number_format($amount, 2, '.', ''); //$decimals = 2, $decPoint = '.' , $thousands_sep = ''

        $inputs['Currency'] = $this->Amount->getCurrency();
<?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.");
        }
    }

}
        $inputs['ReturnURL'] = $inputs['CancelURL'] = Director::absoluteBaseURL() . EwayPayment_Handler::complete_link($this);

        $inputs['CompanyName'] = $this->config()->get('company_name');
        $inputs['MerchantReference'] = $inputs['MerchantInvoice'] = $order->ID;
        //$inputs['InvoiceDescription'] =

        $inputs['PageTitle'] = $this->config()->get('page_title');
        $inputs['PageDescription'] = 'Please fill the details below to complete your order.';
        if ($logo = $this->config()->get('company_logo')) {
            $inputs['CompanyLogo'] = Director::absoluteBaseURL() . $logo;
        }

        // 7) Prepopulating Customer Informations

        $address = $this->Order()->BillingAddress();
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 { }

        $inputs['CustomerFirstName'] = $address->FirstName;
        $inputs['CustomerLastName'] = $address->Surname;
        $inputs['CustomerAddress'] = "$address->Address $address->Address2";
        $inputs['CustomerPostCode'] = $address->PostalCode;
        $inputs['CustomerCity'] = $address->City;
        $inputs['CustomerCountry'] = (class_exists("Geoip") ? Geoip::countryCode2name($address->Country) : $address->Country);
        $inputs['CustomerPhone'] = $address->Phone;
        $inputs['CustomerEmail'] = $address->Email;
        $inputs['CustomerState'] = $address->RegionCode;
        if ($this->config()->get('test_mode') == 'yes') {
            $inputs['CompanyName'] = "TEST FOR ".$inputs['CompanyName'];
            debug::log(print_r($inputs, 1));
            debug::log($this->config()->get('url'));
        }
        return $this->config()->get('url') . '?' . http_build_query($inputs);
    }

    public function EwayForm($url)

    {
        Requirements::javascript(THIRDPARTY_DIR . '/jquery/jquery.js');
        return <<<HTML
			<form id="EwayForm" method="post" action="$url">
				<input type="submit" value="Pay Now" />
				<p>Continue through to payment page - if this does not happen automatically then please click above.</p>
			</form>
			<script type="text/javascript">
				jQuery(document).ready(function() {
					window.setTimeout(
						function(){
							jQuery("input[type='submit']").hide();
							jQuery('#EwayForm').submit();
						},
						200
					);
				});
			</script>
HTML;
    }

    public function EwayConfirmationURL($code)
    {
        $inputs = array('AccessPaymentCode' => $code);
        if ($this->config()->get('test_mode') == 'yes') {

            $inputs['CustomerID'] = $this->config()->get('test_customer_id');
            $inputs['UserName'] = $this->config()->get('test_customer_username');
        } else {
            $inputs['CustomerID'] = $this->config()->get('customer_id');
            $inputs['UserName'] = $this->config()->get('customer_username');
        }
        return $this->config()->get('confirmation_url') . '?' . http_build_query($inputs);
    }

    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.");
        }
    }

}
    }
}

/**
 * Handler for responses from the Eway site
 */
class EwayPayment_Handler extends Controller
namespace YourVendor;

class YourClass { }
{
    private static $allowed_actions = array(

        "complete"
    );

    private static $url_segment = 'ewaypayment_handler';


    public static function complete_link(EwayPayment $payment)
    {
        return Config::inst()->get('EwayPayment_Handler', 'url_segment') . "/complete?code={$payment->ID}-{$payment->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.");
        }
    }

}
    }

    /**
     * Manages the 'return' and 'cancel' replies
     */
    public function complete()
// 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);
    }
}
    {
        $this->extend("EwayPayment_Handler_completion_start");
        if (isset($_REQUEST['code']) && $code = $_REQUEST['code']) {
            $params = explode('-', $code);
            if (count($params) == 2) {
                $payment = EwayPayment::get()->byID(intval($params[0]));
                if ($payment && $payment->AuthorisationCode == $params[1]) {
                    if (isset($_REQUEST['AccessPaymentCode'])) {
                        $url = $payment->EwayConfirmationURL($_REQUEST['AccessPaymentCode']);
                        $response = file_get_contents($url);
                        if ($response) {
                            $response = Convert::xml2array($response);
                            if (isset($response['ResponseCode']) && $response['ResponseCode'] == '00') {
                                $payment->Status = 'Success';
                            } else {
                                $payment->Status = 'Failure';
                            }
                        } else {
                            $payment->Status = 'Failure';
                        }
                        $payment->write();
                        $payment->redirectToOrder();
                    }
                }
            }
        }
    }
}


1			<?php
2
3			/**
4			* @see http://www.eway.com.au/developers/api/shared-payments
5			* @see http://www.eway.com.au/docs/api-documentation/sharedpaymentpagedoc.pdf
6			* http://www.eway.com.au/developers/resources/response-codes
7			*
8			*
9			* test CC:
10			* 4444333322221111
11			* any expiry, name, etc...
12			*
13			*/
14			class EwayPayment extends EcommercePayment
			0 ignored issues – show Coding Style Compatibility introduced 2017-01-03 01:26 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
15			{
16			private static $db = array(
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:26 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-01-03 01:26 UTC by Report Bug Copy Issue Report The property `$db` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
17			'AuthorisationCode' => 'Text'
18			);
19
20			// Eway Information
21
22			private static $privacy_link = 'https://www.eway.com.au/Company/About/Privacy.aspx';
			0 ignored issues – show Unused Code introduced 2017-01-03 01:26 UTC by Report Bug Copy Issue Report The property `$privacy_link` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
23
24			private static $logo = '/payment_eway/images/eway.png';
			0 ignored issues – show Unused Code introduced 2017-01-03 01:26 UTC by Report Bug Copy Issue Report The property `$logo` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
25
26			// Company Information
27
28			private static $page_title = 'Your Title';
			0 ignored issues – show Unused Code introduced 2017-01-03 01:26 UTC by Report Bug Copy Issue Report The property `$page_title` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
29
30			private static $company_name = 'Your Company Name';
			0 ignored issues – show Unused Code introduced 2017-01-03 01:26 UTC by Report Bug Copy Issue Report The property `$company_name` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
31
32			private static $payment_explanation = 'Your payment will be processed by the eWay payment processing site.';
			0 ignored issues – show Unused Code introduced 2017-01-03 01:26 UTC by Report Bug Copy Issue Report The property `$payment_explanation` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
33

sunnysideup / silverstripe-payment_eway

EwayPayment A last analyzed 2018-03-20 01:24 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

7 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like

EwayPayment A
last analyzed 2018-03-20 01:24 UTC