MifMessage

Complexity

Total Complexity

15

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	2
A	get_attribute()	0	5	1
A	get_element_text()	0	15	3
D	get_element_index()	0	36	9

<?php

#******************************************************************************
#* Name          : PxPay_Curl.inc.php
#* Description   : Classes used interact with the PxPay interface using PHP with the cURL extension installed
#* Copyright	 : Payment Express 2017(c)
#* Date          : 2017-04-10
#*@version 		 : 2.0
#* Author 		 : Payment Express DevSupport
#******************************************************************************
# Use this class to parse an XML document
class MifMessage

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

{
    public $xml_;
    public $xml_index_;
    public $xml_value_;

    # Constructor:
    # Create a MifMessage with the specified XML text.
    # The constructor returns a null object if there is a parsing error.
    public function __construct($xml)
    {
        $p = xml_parser_create();
        xml_parser_set_option($p, XML_OPTION_CASE_FOLDING, 0);
        $ok = xml_parse_into_struct($p, $xml, $value, $index);
        xml_parser_free($p);
        if ($ok) {
            $this->xml_ = $xml;
            $this->xml_value_ = $value;
            $this->xml_index_ = $index;
        }
    }

    # Return the value of the specified top-level attribute.
    # This method can only return attributes of the root element.
    # If the attribute is not found, return "".
    public function get_attribute($attribute)

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

    {
        $attributes = $this->xml_value_[0]["attributes"];
        return $attributes[$attribute];
    }

    # Return the text of the specified element.
    # The element is given as a simplified XPath-like name.
    # For example, "Link/ServerOk" refers to the ServerOk element
    # nested in the Link element (nested in the root element).
    # If the element is not found, return "".
    public function get_element_text($element)

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

    {
        $index = $this->get_element_index($element, 0);
        if ($index == 0) {
            return "";
        } else {
            #When element existent but empty
            $elementObj = $this->xml_value_[$index];
            if (! array_key_exists("value", $elementObj)) {
                return "";
            }
   
            return $this->xml_value_[$index]["value"];
        }
    }

    # (internal method)
    # Return the index of the specified element,
    # relative to some given root element index.
    #
    public function get_element_index($element, $rootindex = 0)

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

    {
        #$element = strtoupper($element);

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

        $pos = strpos($element, "/");
        if ($pos !== false) {
            # element contains '/': find first part
            $start_path = substr($element, 0, $pos);
            $remain_path = substr($element, $pos+1);
            $index = $this->get_element_index($start_path, $rootindex);
            if ($index == 0) {
                # couldn't find first part give up.
                return 0;
            }
            # recursively find rest
            return $this->get_element_index($remain_path, $index);
        } else {
            # search from the parent across all its children
            # i.e. until we get the parent's close tag.
            $level = $this->xml_value_[$rootindex]["level"];
            if ($this->xml_value_[$rootindex]["type"] == "complete") {
                return 0;   # no children
            }
            $index = $rootindex+1;
            while ($index<count($this->xml_value_) &&
             !($this->xml_value_[$index]["level"]==$level &&
               $this->xml_value_[$index]["type"]=="close")) {
                # if one below parent and tag matches, bingo
                if ($this->xml_value_[$index]["level"] == $level+1 &&
            $this->xml_value_[$index]["tag"] == $element) {
                    return $index;
                }
                $index++;
            }
            return 0;
        }
    }
}

class PxPay_Curl

PSR1 recommends that each class should be in its own file to aid autoloaders.

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

{
    public $PxPay_Key;
    public $PxPay_Url;
    public $PxPay_Userid;
    public function __construct($Url, $UserId, $Key)
    {
        error_reporting(E_ERROR);
        $this->PxPay_Key = $Key;
        $this->PxPay_Url = $Url;
        $this->PxPay_Userid = $UserId;
    }
    
    #******************************************************************************
    # Create a request for the PxPay interface
    #******************************************************************************
    public function makeRequest($request)
    {
        #Validate the Request
        if ($request->validData() == false) {
            return "" ;
        }

        $request->setUserId($this->PxPay_Userid);
        $request->setKey($this->PxPay_Key);
        
        $xml = $request->toXml();
        
        $result = $this->submitXml($xml);
  
        return $result;
    }
            
    #******************************************************************************
    # Return the transaction outcome details
    #******************************************************************************
    public function getResponse($result)
    {
        $inputXml = "<ProcessResponse><PxPayUserId>".$this->PxPay_Userid."</PxPayUserId><PxPayKey>".$this->PxPay_Key.
        "</PxPayKey><Response>".$result."</Response></ProcessResponse>";
        
        $outputXml = $this->submitXml($inputXml);
        
        $pxresp = new PxPayResponse($outputXml);
        return $pxresp;
    }
    
    #******************************************************************************
    # Actual submission of XML using cURL. Returns output XML
    #******************************************************************************
    public function submitXml($inputXml)
    {
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $this->PxPay_Url);
        
        curl_setopt($ch, CURLOPT_POST, 1);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $inputXml);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
        
        #set up proxy, this may change depending on ISP, please contact your ISP to get the correct cURL settings
        #curl_setopt($ch,CURLOPT_PROXY , "proxy:8080");

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

        #curl_setopt($ch,CURLOPT_PROXYUSERPWD,"username:password");

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

        $outputXml = curl_exec($ch);
            
        curl_close($ch);
  
        return $outputXml;
    }
}

#******************************************************************************
# Class for PxPay request messages.
#******************************************************************************
class PxPayRequest extends PxPayMessage

PSR1 recommends that each class should be in its own file to aid autoloaders.

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

{
    public $UrlFail;
    public $UrlSuccess;
    public $AmountInput;
    public $EnableAddBillCard;
    public $PxPayUserId;
    public $PxPayKey;
    public $Opt;
    
    
    #Constructor
    public function __construct()
    {
        parent::__construct();
    }
    
    public function setEnableAddBillCard($EnableBillAddCard)
    {
        $this->EnableAddBillCard = $EnableBillAddCard;
    }
    public function setUrlFail($UrlFail)
    {
        $this->UrlFail = $UrlFail;
    }
    public function setUrlSuccess($UrlSuccess)
    {
        $this->UrlSuccess = $UrlSuccess;
    }
    public function setAmountInput($AmountInput)
    {
        $this->AmountInput = sprintf("%9.2f", $AmountInput);
    }
    public function setUserId($UserId)
    {
        $this->PxPayUserId = $UserId;
    }
    public function setKey($Key)
    {
        $this->PxPayKey = $Key;
    }
    public function setOpt($Opt)
    {
        $this->Opt = $Opt;
    }
    

    #******************************************************************
    #Data validation
    #******************************************************************
    public function validData()
    {
        $msg = "";
        if ($this->TxnType != "Purchase") {
            if ($this->TxnType != "Auth") {
                $msg = "Invalid TxnType[$this->TxnType]<br>";
            }
        }
        
        if (strlen($this->MerchantReference) > 64) {
            $msg = "Invalid MerchantReference [$this->MerchantReference]<br>";
        }
        
        if (strlen($this->TxnId) > 16) {
            $msg = "Invalid TxnId [$this->TxnId]<br>";
        }
        if (strlen($this->TxnData1) > 255) {
            $msg = "Invalid TxnData1 [$this->TxnData1]<br>";
        }
        if (strlen($this->TxnData2) > 255) {
            $msg = "Invalid TxnData2 [$this->TxnData2]<br>";
        }
        if (strlen($this->TxnData3) > 255) {
            $msg = "Invalid TxnData3 [$this->TxnData3]<br>";
        }
            
        if (strlen($this->EmailAddress) > 255) {
            $msg = "Invalid EmailAddress [$this->EmailAddress]<br>";
        }
            
        if (strlen($this->UrlFail) > 255) {
            $msg = "Invalid UrlFail [$this->UrlFail]<br>";
        }
        if (strlen($this->UrlSuccess) > 255) {
            $msg = "Invalid UrlSuccess [$this->UrlSuccess]<br>";
        }
        if (strlen($this->BillingId) > 32) {
            $msg = "Invalid BillingId [$this->BillingId]<br>";
        }
        
        if ($msg != "") {
            trigger_error($msg, E_USER_ERROR);
            return false;
        }
        return true;
    }
}

#******************************************************************************
# Abstract base class for PxPay messages.
# These are messages with certain defined elements,  which can be serialized to XML.

#******************************************************************************
class PxPayMessage

PSR1 recommends that each class should be in its own file to aid autoloaders.

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

{
    public $TxnType;
    public $CurrencyInput;
    public $TxnData1;
    public $TxnData2;
    public $TxnData3;
    public $MerchantReference;
    public $EmailAddress;
    public $BillingId;
    public $TxnId;
    
    public function __construct()
    {
    }

    public function setBillingId($BillingId)
    {
        $this->BillingId = $BillingId;
    }
    public function getBillingId()

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

    {
        return $this->BillingId;
    }
    public function setTxnType($TxnType)
    {
        $this->TxnType = $TxnType;
    }
    public function getTxnType()

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

    {
        return $this->TxnType;
    }
    public function setCurrencyInput($CurrencyInput)
    {
        $this->CurrencyInput = $CurrencyInput;
    }
    public function getCurrencyInput()

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

    {
        return $this->CurrencyInput;
    }
    public function setMerchantReference($MerchantReference)
    {
        $this->MerchantReference = $MerchantReference;
    }
    public function getMerchantReference()

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

    {
        return $this->MerchantReference;
    }
    public function setEmailAddress($EmailAddress)
    {
        $this->EmailAddress = $EmailAddress;
    }
    public function getEmailAddress()

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

    {
        return $this->EmailAddress;
    }
    public function setTxnData1($TxnData1)
    {
        $this->TxnData1 = $TxnData1;
    }
    public function getTxnData1()

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

    {
        return $this->TxnData1;
    }
    public function setTxnData2($TxnData2)
    {
        $this->TxnData2 = $TxnData2;
    }
    public function getTxnData2()

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

    {
        return $this->TxnData2;
    }
    public function getTxnData3()

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

    {
        return $this->TxnData3;
    }
    public function setTxnData3($TxnData3)
    {
        $this->TxnData3 = $TxnData3;
    }
    public function setTxnId($TxnId)
    {
        $this->TxnId = $TxnId;
    }
    public function getTxnId()

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

    {
        return $this->TxnId;
    }
    
    public function toXml()
    {
        $arr = get_object_vars($this);

        $xml  = "<GenerateRequest>";
        while (list($prop, $val) = each($arr)) {
            $xml .= "<$prop>$val</$prop>" ;
        }

        $xml .= "</GenerateRequest>";
        return $xml;
    }
}

#******************************************************************************
# Class for PxPay response messages.
#******************************************************************************

class PxPayResponse extends PxPayMessage

PSR1 recommends that each class should be in its own file to aid autoloaders.

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

{
    public $Success;
    public $AuthCode;
    public $CardName;
    public $CardHolderName;
    public $CardNumber;
    public $DateExpiry;
    public $ClientInfo;
    public $DpsTxnRef;
    public $DpsBillingId;
    public $AmountSettlement;
    public $CurrencySettlement;
    public $TxnMac;
    public $ResponseText;

 
    public function __construct($xml)
    {
        $msg = new MifMessage($xml);
        parent::__construct();
        
        $this->Success = $msg->get_element_text("Success");
        $this->setTxnType($msg->get_element_text("TxnType"));
        $this->CurrencyInput = $msg->get_element_text("CurrencyInput");
        $this->setMerchantReference($msg->get_element_text("MerchantReference"));
        $this->setTxnData1($msg->get_element_text("TxnData1"));
        $this->setTxnData2($msg->get_element_text("TxnData2"));
        $this->setTxnData3($msg->get_element_text("TxnData3"));
        $this->AuthCode = $msg->get_element_text("AuthCode");
        $this->CardName = $msg->get_element_text("CardName");
        $this->CardHolderName = $msg->get_element_text("CardHolderName");
        $this->CardNumber = $msg->get_element_text("CardNumber");
        $this->DateExpiry = $msg->get_element_text("DateExpiry");
        $this->ClientInfo = $msg->get_element_text("ClientInfo");
        $this->TxnId = $msg->get_element_text("TxnId");
        $this->setEmailAddress($msg->get_element_text("EmailAddress"));
        $this->DpsTxnRef = $msg->get_element_text("DpsTxnRef");
        $this->BillingId = $msg->get_element_text("BillingId");
        $this->DpsBillingId = $msg->get_element_text("DpsBillingId");
        $this->AmountSettlement = $msg->get_element_text("AmountSettlement");
        $this->CurrencySettlement = $msg->get_element_text("CurrencySettlement");
        $this->TxnMac = $msg->get_element_text("TxnMac");
        $this->ResponseText = $msg->get_element_text("ResponseText");
    }


    public function getSuccess()

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

    {
        return $this->Success;
    }
    public function getAuthCode()

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

    {
        return $this->AuthCode;
    }
    public function getCardName()

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

    {
        return $this->CardName;
    }
    public function getCardHolderName()

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

    {
        return $this->CardHolderName;
    }
    public function getCardNumber()

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

    {
        return $this->CardNumber;
    }
    public function getDateExpiry()

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

    {
        return $this->DateExpiry;
    }
    public function getClientInfo()

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

    {
        return $this->ClientInfo;
    }
    public function getDpsTxnRef()

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

    {
        return $this->DpsTxnRef;
    }
    public function getDpsBillingId()

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

    {
        return $this->DpsBillingId;
    }
    public function getAmountSettlement()

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

    {
        return $this->AmountSettlement;
    }
    public function getCurrencySettlement()
    {
        $this->CurrencySettlement;
    }
    public function getTxnMac()

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

    {
        return $this->TxnMac;
    }
    public function getResponseText()

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

    {
        return $this->ResponseText;
    }
}