add some doc in module payment interface

This commit is contained in:
Manuel Raynaud
2014-03-06 15:41:41 +01:00
parent 16db61a237
commit ef5e3f44a7
2 changed files with 13 additions and 8 deletions

View File

@@ -27,14 +27,18 @@ use Thelia\Model\Order;
interface PaymentModuleInterface extends BaseModuleInterface
{
const NOT_PAID = 1;
const PAID = 2;
const PROCESSING = 3;
const SENT = 4;
const CANCELED = 5;
/**
* @return mixed
*
* Method used by payment gateway.
*
* If this method return a \Thelia\Core\HttpFoundation\Response instance, this response is send to the
* browser.
*
* In many cases, it's necessary to send a form to the payment gateway. On your response you can return this form already
* completed, ready to be sent
*
* @param \Thelia\Model\Order $order processed order
* @return null|\Thelia\Core\HttpFoundation\Response
*/
public function pay(Order $order);