DpsPxPayComs

Complexity

Total Complexity

38

Size/Duplication

Total Lines	270
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	get_txn_type()	0	5	2
A	setTxnData1()	0	4	1
A	setTxnData2()	0	4	1
A	setTxnData3()	0	4	1
A	setEmailAddress()	0	4	1
A	setAmountInput()	0	4	1
A	setMerchantReference()	0	4	1
A	setCurrencyInput()	0	4	1
A	setTxnType()	0	4	1
A	setTxnId()	0	4	1
A	setUrlFail()	0	4	1
A	setUrlSuccess()	0	4	1
A	setEnableAddBillCard()	0	4	1
A	setBillingId()	0	4	1
B	__construct()	0	22	5
F	startPaymentProcess()	0	78	15
A	processRequestAndReturnResultsAsObject()	0	6	1
A	getDebugMessage()	0	8	1
A	debug()	0	5	1

<?php
/**
 *@author nicolaas [at] sunnysideup.co.nz
 **/

class DpsPxPayComs extends Object

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    private static $pxpay_url = 'https://sec.paymentexpress.com/pxaccess/pxpay.aspx';

The property $pxpay_url is not used and could be removed.

    private static $pxpay_userid = "";

The property $pxpay_userid is not used and could be removed.

    private static $pxpay_encryption_key =  "";

The property $pxpay_encryption_key is not used and could be removed.

    private static $alternative_thirdparty_folder =  "";

    private static $overriding_txn_type =  ""; //e.g. AUTH

The property $overriding_txn_type is not used and could be removed.

    public static function get_txn_type()
    {
        $overridingTxnType = Config::inst()->get("DpsPxPayComs", "overriding_txn_type");
        return $overridingTxnType  ? $overridingTxnType : "Purchase";
    }


    /**
    * customer details
    **/

    protected $TxnData1 = "";
    public function setTxnData1($v)
    {
        $this->TxnData1 = $v;
    }
    protected $TxnData2 = "";
    public function setTxnData2($v)
    {
        $this->TxnData2 = $v;
    }
    protected $TxnData3 = "";
    public function setTxnData3($v)
    {
        $this->TxnData3 = $v;
    }
    protected $EmailAddress = "";
    public function setEmailAddress($v)
    {
        $this->EmailAddress = $v;
    }

    /**
    * order details
    **/
    protected $AmountInput = 0;
    public function setAmountInput($v)
    {
        $this->AmountInput = $v;
    }

    protected $MerchantReference = "";
    public function setMerchantReference($v)
    {
        $this->MerchantReference = $v;
    }

    protected $CurrencyInput = "NZD";
    public function setCurrencyInput($v)
    {
        $this->CurrencyInput = $v;
    }

    protected $TxnType = "Purchase";
    public function setTxnType($v)
    {
        $this->TxnType = $v;
    }

    protected $TxnId = "";
    public function setTxnId($v)
    {
        $this->TxnId = $v;
    }

    /**
    * details of the redirection
    **/
    protected $UrlFail = "";
    public function setUrlFail($v)
    {
        $this->UrlFail = $v;
    }
    protected $UrlSuccess = "";
    public function setUrlSuccess($v)
    {
        $this->UrlSuccess = $v;
    }

    /**
     * Details to use stored cards
     */
    protected $EnableAddBillCard = 0;
    public function setEnableAddBillCard($v)
    {
        $this->EnableAddBillCard = $v;
    }
    protected $BillingId = 0;
    public function setBillingId($v)
    {
        $this->BillingId = $v;
    }

    /**
    * external object
    **/
    protected $PxPayObject = null;
    protected $response = null;

    public function __construct()
    {
        if (!self::$alternative_thirdparty_folder) {
            self::$alternative_thirdparty_folder = Director::baseFolder().'/payment_dps/code/thirdparty';
        }
        require_once(self::$alternative_thirdparty_folder."/PxPay_Curl.inc.php");
        if (!Config::inst()->get("DpsPxPayComs", "pxpay_url")) {
            user_error("error in DpsPxPayComs::__construct, self::$pxpay_url not set. ", E_USER_WARNING);

The variable $pxpay_url does not exist. Did you forget to declare it?

        }
        if (!Config::inst()->get("DpsPxPayComs", "pxpay_userid")) {
            user_error("error in DpsPxPayComs::__construct, self::$pxpay_userid not set. ", E_USER_WARNING);

The variable $pxpay_userid does not exist. Did you forget to declare it?

        }
        if (!Config::inst()->get("DpsPxPayComs", "pxpay_encryption_key")) {
            user_error("error in DpsPxPayComs::__construct, self::$pxpay_encryption_key not set. ", E_USER_WARNING);

The variable $pxpay_encryption_key does not exist. Did you forget to declare it?

        }

        $this->PxPayObject = new PxPay_Curl(
            Config::inst()->get("DpsPxPayComs", "pxpay_url"),
            Config::inst()->get("DpsPxPayComs", "pxpay_userid"),
            Config::inst()->get("DpsPxPayComs", "pxpay_encryption_key")
        );
    }

    /*
     * This function formats data into a request and returns redirection URL
     * NOTE: you will need to set all the variables prior to running this.
     * e.g. $myDPSPxPayComsObject->setMerchantReference("myreferenceHere");
     **/
    public function startPaymentProcess()

The return type could not be reliably inferred; please add a @return annotation.

    {
        if (!$this->TxnId) {
            $this->TxnId = uniqid("ID");
        }
        $request = new PxPayRequest();

        #Set PxPay properties
        if ($this->MerchantReference) {
            $request->setMerchantReference($this->MerchantReference);
        } else {
            user_error("error in DpsPxPayComs::startPaymentProcess, MerchantReference not set. ", E_USER_WARNING);
        }
        if ($this->AmountInput) {
            $request->setAmountInput($this->AmountInput);
        } else {
            user_error("error in DpsPxPayComs::startPaymentProcess, AmountInput not set. ", E_USER_WARNING);
        }
        if ($this->TxnData1) {
            $request->setTxnData1($this->TxnData1);
        }
        if ($this->TxnData2) {
            $request->setTxnData2($this->TxnData2);
        }
        if ($this->TxnData3) {
            $request->setTxnData3($this->TxnData3);
        }
        if ($this->TxnType) {
            $request->setTxnType($this->TxnType);
        } else {
            user_error("error in DpsPxPayComs::startPaymentProcess, TxnType not set. ", E_USER_WARNING);
        }
        if ($this->CurrencyInput) {
            $request->setCurrencyInput($this->CurrencyInput);
        } else {
            user_error("error in DpsPxPayComs::startPaymentProcess, CurrencyInput not set. ", E_USER_WARNING);
        }
        if ($this->EmailAddress) {
            $request->setEmailAddress($this->EmailAddress);
        }
        if ($this->UrlFail) {
            $request->setUrlFail($this->UrlFail);
        } else {
            user_error("error in DpsPxPayComs::startPaymentProcess, UrlFail not set. ", E_USER_WARNING);
        }
        if ($this->UrlSuccess) {
            $request->setUrlSuccess($this->UrlSuccess);
        } else {
            user_error("error in DpsPxPayComs::startPaymentProcess, UrlSuccess not set. ", E_USER_WARNING);
        }
        if ($this->TxnId) {
            $request->setTxnId($this->TxnId);
        }
        if ($this->EnableAddBillCard) {
            $request->setEnableAddBillCard($this->EnableAddBillCard);
        }
        if ($this->BillingId) {
            $request->setBillingId($this->BillingId);
        }

        /* TODO:

70% of this comment could be valid code. Did you maybe forget this after debugging?

        $request->setEnableAddBillCard($EnableAddBillCard);
        $request->setBillingId($BillingId);
        $request->setOpt($Opt);
        */

        #Call makeRequest function to obtain input XML
        $request_string = $this->PxPayObject->makeRequest($request);

        #Obtain output XML
        $this->response = new MifMessage($request_string);
        #Parse output XML
        $url = $this->response->get_element_text("URI");
        //$valid = $this->response->get_attribute("valid");

62% of this comment could be valid code. Did you maybe forget this after debugging?

        #Redirect to payment page
        return $url;
    }


    /*

43% of this comment could be valid code. Did you maybe forget this after debugging?

     * This function receives information back from the payments page as a response object
     * --------------------- RESPONSE DATA ---------------------
     * $Success           = $responseObject->getSuccess();   # =1 when request succeeds
     * $AmountSettlement  = $responseObject->getAmountSettlement();
     * $AuthCode          = $responseObject->getAuthCode();  # from bank
     * $CardName          = $responseObject->getCardName();  # e.g. "Visa"
     * $CardNumber        = $responseObject->getCardNumber(); # Truncated card number
     * $DateExpiry        = $responseObject->getDateExpiry(); # in mmyy format
     * $DpsBillingId      = $responseObject->getDpsBillingId();
     * $BillingId         = $responseObject->getBillingId();
     * $CardHolderName    = $responseObject->getCardHolderName();
     * $DpsTxnRef	        = $responseObject->getDpsTxnRef();
     * $TxnType           = $responseObject->getTxnType();
     * $TxnData1          = $responseObject->getTxnData1();
     * $TxnData2          = $responseObject->getTxnData2();
     * $TxnData3          = $responseObject->getTxnData3();
     * $CurrencySettlement= $responseObject->getCurrencySettlement();
     * $ClientInfo        = $responseObject->getClientInfo(); # The IP address of the user who submitted the transaction
     * $TxnId             = $responseObject->getTxnId();
     * $CurrencyInput     = $responseObject->getCurrencyInput();
     * $EmailAddress      = $responseObject->getEmailAddress();
     * $MerchantReference = $responseObject->getMerchantReference();
     * $ResponseText      = $responseObject->getResponseText();
     * $TxnMac            = $responseObject->getTxnMac(); # An indication as to the uniqueness of a card used in relation to others
     *
     * also see: https://www.paymentexpress.com/technical_resources/ecommerce_hosted/error_codes.html
     **/

    public function processRequestAndReturnResultsAsObject()

processRequestAndReturnResultsAsObject uses the super-global variable $_REQUEST which is generally not recommended.

    {
        #getResponse method in PxPay object returns PxPayResponse object
        #which encapsulates all the response data
        return $this->PxPayObject->getResponse($_REQUEST["result"]);
    }

    public function getDebugMessage()
    {
        $string = "<pre>";
        $string .= print_r($this->PxPayObject, true);
        $string .= print_r($this->response, true);
        $string .= "</pre>";
        return $string;
    }

    public function debug()
    {
        debug::show("debugging DpsPxPayComs");
        echo $this->getDebugMessage();
    }
}