PHP Interface Sonata\Component\Payment\PaymentInterface

Afficher le fichier Open project: sonata-project/ecommerce Interface Usage Examples

Méthodes publiques

Méthode	Description
applyTransactionId ( Sonata\Component\Payment\TransactionInterface $transaction )	return the transaction id from the bank.
callback ( Sonata\Component\Payment\TransactionInterface $transaction ) : Response
encodeString ( string $value ) : string	encode value for the bank.
getCode ( ) : string
getName ( ) : string
getOrderReference ( Sonata\Component\Payment\TransactionInterface $transaction ) : string	return the order reference from the transaction.
getTransformer ( $name ) : BaseTransformer	Gets the transformer for $name.
handleError ( Sonata\Component\Payment\TransactionInterface $transaction ) : Response	Method called when an error occurs.
isAddableProduct ( Sonata\Component\Basket\BasketInterface $basket, Sonata\Component\Product\ProductInterface $product )	return true if the product can be added to the basket.
isBasketValid ( Sonata\Component\Basket\BasketInterface $basket ) : boolean	return true is the basket is valid for the current bank gateway.
isCallbackValid ( Sonata\Component\Payment\TransactionInterface $transaction ) : boolean
isRequestValid ( Sonata\Component\Payment\TransactionInterface $transaction ) : boolean	Test if the request variables are valid for the current request.
sendConfirmationReceipt ( Sonata\Component\Payment\TransactionInterface $transaction ) : Response,,Symfony\Component\HttpFoundation	Send post back confirmation to the bank when the bank callback the site.
sendbank ( Sonata\Component\Order\OrderInterface $order ) : Response	Send information to the bank, this method should handle everything when called.

Method Details

applyTransactionId() public méthode

return the transaction id from the bank.

public applyTransactionId ( Sonata\Component\Payment\TransactionInterface $transaction )
$transaction	Sonata\Component\Payment\TransactionInterface

callback() public méthode

public callback ( Sonata\Component\Payment\TransactionInterface $transaction ) : Response
$transaction	Sonata\Component\Payment\TransactionInterface
Résultat	Symfony\Component\HttpFoundation\Response

encodeString() public méthode

encode value for the bank.

public encodeString ( string $value ) : string
$value	string
Résultat	string	the encoded value

getCode() public méthode

public getCode ( ) : string
Résultat	string

getName() public méthode

public getName ( ) : string
Résultat	string

getOrderReference() public méthode

return the order reference from the transaction.

public getOrderReference ( Sonata\Component\Payment\TransactionInterface $transaction ) : string
$transaction	Sonata\Component\Payment\TransactionInterface
Résultat	string

getTransformer() public méthode

Gets the transformer for $name.

public getTransformer ( $name ) : BaseTransformer
$name
Résultat	Sonata\Component\Transformer\BaseTransformer

handleError() public méthode

Method called when an error occurs.

public handleError ( Sonata\Component\Payment\TransactionInterface $transaction ) : Response
$transaction	Sonata\Component\Payment\TransactionInterface
Résultat	Symfony\Component\HttpFoundation\Response

isAddableProduct() public méthode

return true if the product can be added to the basket.

public isAddableProduct ( Sonata\Component\Basket\BasketInterface $basket, Sonata\Component\Product\ProductInterface $product )
$basket	Sonata\Component\Basket\BasketInterface
$product	Sonata\Component\Product\ProductInterface

isBasketValid() public méthode

return true is the basket is valid for the current bank gateway.

public isBasketValid ( Sonata\Component\Basket\BasketInterface $basket ) : boolean
$basket	Sonata\Component\Basket\BasketInterface
Résultat	boolean

isCallbackValid() public méthode

public isCallbackValid ( Sonata\Component\Payment\TransactionInterface $transaction ) : boolean
$transaction	Sonata\Component\Payment\TransactionInterface
Résultat	boolean	true if callback ok else false

isRequestValid() public méthode

WARNING : this methods does not check if the callback is valid

public isRequestValid ( Sonata\Component\Payment\TransactionInterface $transaction ) : boolean
$transaction	Sonata\Component\Payment\TransactionInterface
Résultat	boolean	true if all parameter are ok

sendConfirmationReceipt() public méthode

Send post back confirmation to the bank when the bank callback the site.

public sendConfirmationReceipt ( Sonata\Component\Payment\TransactionInterface $transaction ) : Response,,Symfony\Component\HttpFoundation
$transaction	Sonata\Component\Payment\TransactionInterface
Résultat	Response,,Symfony\Component\HttpFoundation

sendbank() public méthode

Send information to the bank, this method should handle everything when called.

public sendbank ( Sonata\Component\Order\OrderInterface $order ) : Response
$order	Sonata\Component\Order\OrderInterface
Résultat	Symfony\Component\HttpFoundation\Response