Process IPC method: IPCIAPurchase. Collect, validate and send API params

Mypos\IPC\Base
Extended byMypos\IPC\IAPurchase
Namespace: Mypos\IPC
Located at IAPurchase.php 

Methods summary

public
#__construct( Mypos\IPC\Config $cnf )

Return purchase object

public Mypos\IPC\IAPurchase
#setOrderID( string $orderID )

Purchase identifier - must be unique

public Mypos\IPC\IAPurchase
#setNote( string $note )

Optional note to purchase

public
#setAccountSettlement( string $accountSettlement )

Account for payment settlement

public Mypos\IPC\Response
#process( )

Initiate API request

public boolean
#validate( )

Validate all set purchase details

public string
#getCurrency( )

ISO-4217 Three letter currency code

public Mypos\IPC\IAPurchase
#setCurrency( string $currency )

ISO-4217 Three letter currency code

public Mypos\IPC\Cart
#getCart( )

Cart object

public Mypos\IPC\IAPurchase
#setCart( Mypos\IPC\Cart $cart )

Cart object

public Mypos\IPC\Card
#getCard( )

Card object

public
#setCard( Mypos\IPC\Card $card )

Card object

public string
#getOrderID( )

Purchase identifier

public string
#getAccountSettlement( )

Account for payment settlement

public string
#getNote( )

Optional note to purchase

Properties summary

Properties inherited from Mypos\IPC\Base

$outputFormat

 

 

Example

<?php
namespace Mypos\IPC;
/**
 * Process IPC method: IPCIAPurchase.
 * Collect, validate and send API params
 */
class IAPurchase extends Base
{
    /**
     * @var Cart
     */
    private $cart;
    /**
     * @var Card
     */
    private $card;
    private $currency = 'EUR', $note, $orderID, $accountSettlement;
    /**
     * Return purchase object
     *
     * @param Config $cnf
     */
    public function __construct(Config $cnf)
    {
        $this->setCnf($cnf);
    }
    /**
     * Purchase identifier - must be unique
     *
     * @param string $orderID
     *
     * @return IAPurchase
     */
    public function setOrderID($orderID)
    {
        $this->orderID = $orderID;
        return $this;
    }
    /**
     * Optional note to purchase
     *
     * @param string $note
     *
     * @return IAPurchase
     */
    public function setNote($note)
    {
        $this->note = $note;
        return $this;
    }
    /**
     * Account for payment settlement
     *
     * @param string $accountSettlement
     */
    public function setAccountSettlement($accountSettlement)
    {
        $this->accountSettlement = $accountSettlement;
    }
    /**
     * Initiate API request
     *
     * @return Response
     */
    public function process()
    {
        $this->validate();
        $this->_addPostParam('IPCmethod', 'IPCIAPurchase');
        $this->_addPostParam('IPCVersion', $this->getCnf()->getVersion());
        $this->_addPostParam('IPCLanguage', $this->getCnf()->getLang());
        $this->_addPostParam('SID', $this->getCnf()->getSid());
        $this->_addPostParam('WalletNumber', $this->getCnf()->getWallet());
        $this->_addPostParam('KeyIndex', $this->getCnf()->getKeyIndex());
        $this->_addPostParam('Source', $this->getCnf()->getSource());
        $this->_addPostParam('OrderID', $this->getOrderID());
        $this->_addPostParam('Amount', $this->getCart()->getTotal());
        $this->_addPostParam('Currency', $this->getCurrency());
        if ($this->getCard()->getCardToken()) {
            $this->_addPostParam('CardToken', $this->getCard()->getCardToken());
        } else {
            $this->_addPostParam('CardType', $this->getCard()->getCardType());
            $this->_addPostParam('PAN', $this->getCard()->getCardNumber(), true);
            $this->_addPostParam('CardholderName', $this->getCard()->getCardHolder());
            $this->_addPostParam('ExpDate', $this->getCard()->getExpDate(), true);
            $this->_addPostParam('CVC', $this->getCard()->getCvc(), true);
            $this->_addPostParam('ECI', $this->getCard()->getEci());
            $this->_addPostParam('AVV', $this->getCard()->getAvv());
            $this->_addPostParam('XID', $this->getCard()->getXid());
        }
        $this->_addPostParam('AccountSettlement', $this->getAccountSettlement());
        $this->_addPostParam('Note', $this->getNote());
        $this->_addPostParam('OutputFormat', $this->getOutputFormat());
        $this->_addPostParam('CartItems', $this->getCart()->getItemsCount());
        $items = $this->getCart()->getCart();
        $i = 1;
        foreach ($items as $v) {
            $this->_addPostParam('Article_'.$i, $v['name']);
            $this->_addPostParam('Quantity_'.$i, $v['quantity']);
            $this->_addPostParam('Price_'.$i, $v['price']);
            $this->_addPostParam('Amount_'.$i, $v['price'] * $v['quantity']);
            $this->_addPostParam('Currency_'.$i, $this->getCurrency());
            $i++;
        }
        return $this->_processPost();
    }
    /**
     * Validate all set purchase details
     *
     * @return boolean
     * @throws IPC_Exception
     */
    public function validate()
    {
        if ($this->getCurrency() === null || strpos(Defines::AVL_CURRENCIES, $this->getCurrency()) === false) {
            throw new IPC_Exception('Invalid currency');
        }
        try {
            $this->getCnf()->validate();
        } catch (\Exception $ex) {
            throw new IPC_Exception('Invalid Config details: '.$ex->getMessage());
        }
        try {
            $this->getCart()->validate();
        } catch (\Exception $ex) {
            throw new IPC_Exception('Invalid Cart details: '.$ex->getMessage());
        }
        try {
            $this->getCard()->validate();
        } catch (\Exception $ex) {
            throw new IPC_Exception('Invalid Card details: '.$ex->getMessage());
        }
        return true;
    }
    /**
     * ISO-4217 Three letter currency code
     *
     * @return string
     */
    public function getCurrency()
    {
        return $this->currency;
    }
    /**
     * ISO-4217 Three letter currency code
     *
     * @param string $currency
     *
     * @return IAPurchase
     */
    public function setCurrency($currency)
    {
        $this->currency = $currency;
        return $this;
    }
    /**
     * Cart object
     *
     * @return Cart
     */
    public function getCart()
    {
        return $this->cart;
    }
    /**
     * Cart object
     *
     * @param Cart $cart
     *
     * @return IAPurchase
     */
    public function setCart(Cart $cart)
    {
        $this->cart = $cart;
        return $this;
    }
    /**
     * Card object
     *
     * @return Card
     */
    public function getCard()
    {
        return $this->card;
    }
    /**
     * Card object
     *
     * @param Card $card
     */
    public function setCard($card)
    {
        $this->card = $card;
    }
    /**
     * Purchase identifier
     *
     * @return string
     */
    public function getOrderID()
    {
        return $this->orderID;
    }
    /**
     * Account for payment settlement
     *
     * @return string
     */
    public function getAccountSettlement()
    {
        return $this->accountSettlement;
    }
    /**
     * Optional note to purchase
     *
     * @return string
     */
    public function getNote()
    {
        return $this->note;
    }
}