Rajout du dossier core + MAJ .gitignore
This commit is contained in:
212
core/lib/Thelia/Module/BasePaymentModuleController.php
Normal file
212
core/lib/Thelia/Module/BasePaymentModuleController.php
Normal file
@@ -0,0 +1,212 @@
|
||||
<?php
|
||||
/*************************************************************************************/
|
||||
/* This file is part of the Thelia package. */
|
||||
/* */
|
||||
/* Copyright (c) OpenStudio */
|
||||
/* email : dev@thelia.net */
|
||||
/* web : http://www.thelia.net */
|
||||
/* */
|
||||
/* For the full copyright and license information, please view the LICENSE.txt */
|
||||
/* file that was distributed with this source code. */
|
||||
/*************************************************************************************/
|
||||
|
||||
namespace Thelia\Module;
|
||||
|
||||
use Symfony\Component\Routing\Router;
|
||||
use Thelia\Controller\Front\BaseFrontController;
|
||||
use Thelia\Core\Event\Order\OrderEvent;
|
||||
use Thelia\Core\Event\TheliaEvents;
|
||||
use Thelia\Core\HttpKernel\Exception\RedirectException;
|
||||
use Thelia\Log\Tlog;
|
||||
use Thelia\Model\OrderQuery;
|
||||
use Thelia\Model\OrderStatus;
|
||||
use Thelia\Model\OrderStatusQuery;
|
||||
|
||||
/**
|
||||
* This class implement the minimum
|
||||
*
|
||||
* @package Paypal\Controller
|
||||
* @author Thelia <info@thelia.net>
|
||||
*/
|
||||
abstract class BasePaymentModuleController extends BaseFrontController
|
||||
{
|
||||
protected $log = null;
|
||||
|
||||
/**
|
||||
* Return a module identifier used to calculate the name of the log file,
|
||||
* and in the log messages.
|
||||
*
|
||||
* @return string the module code
|
||||
*/
|
||||
abstract protected function getModuleCode();
|
||||
|
||||
/**
|
||||
* Returns the module-specific logger, initializing it if required.
|
||||
*
|
||||
* @return Tlog a Tlog instance
|
||||
*/
|
||||
protected function getLog()
|
||||
{
|
||||
if ($this->log == null) {
|
||||
$this->log = Tlog::getNewInstance();
|
||||
|
||||
$logFilePath = $this->getLogFilePath();
|
||||
|
||||
$this->log->setPrefix("#LEVEL: #DATE #HOUR: ");
|
||||
$this->log->setDestinations("\\Thelia\\Log\\Destination\\TlogDestinationFile");
|
||||
$this->log->setConfig("\\Thelia\\Log\\Destination\\TlogDestinationFile", 0, $logFilePath);
|
||||
$this->log->setLevel(Tlog::INFO);
|
||||
}
|
||||
|
||||
return $this->log;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string The path to the module's log file.
|
||||
*/
|
||||
protected function getLogFilePath()
|
||||
{
|
||||
return sprintf(THELIA_ROOT."log".DS."%s.log", strtolower($this->getModuleCode()));
|
||||
}
|
||||
|
||||
/**
|
||||
* Process the confirmation of an order. This method should be called
|
||||
* once the module has performed the required checks to confirm a valid payment.
|
||||
*
|
||||
* @param int $order_id the order ID
|
||||
* @throws \Exception
|
||||
*/
|
||||
public function confirmPayment($order_id)
|
||||
{
|
||||
try {
|
||||
$order_id = intval($order_id);
|
||||
|
||||
if (null !== $order = $this->getOrder($order_id)) {
|
||||
$this->getLog()->addInfo(
|
||||
$this->getTranslator()->trans(
|
||||
"Processing confirmation of order ref. %ref, ID %id",
|
||||
array('%ref' => $order->getRef(), '%id' => $order->getId())
|
||||
)
|
||||
);
|
||||
|
||||
$event = new OrderEvent($order);
|
||||
|
||||
$event->setStatus(OrderStatusQuery::getPaidStatus()->getId());
|
||||
|
||||
$this->dispatch(TheliaEvents::ORDER_UPDATE_STATUS, $event);
|
||||
|
||||
$this->getLog()->addInfo(
|
||||
$this->getTranslator()->trans(
|
||||
"Order ref. %ref, ID %id has been successfully paid.",
|
||||
array('%ref' => $order->getRef(), '%id' => $order->getId())
|
||||
)
|
||||
);
|
||||
}
|
||||
} catch (\Exception $ex) {
|
||||
$this->getLog()->addError(
|
||||
$this->getTranslator()->trans(
|
||||
"Error occured while processing order ref. %ref, ID %id: %err",
|
||||
array(
|
||||
'%err' => $ex->getMessage(),
|
||||
'%ref' => ! isset($order) ? "?" : $order->getRef(),
|
||||
'%id' => ! isset($order) ? "?" : $order->getId()
|
||||
)
|
||||
)
|
||||
);
|
||||
|
||||
throw $ex;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Process the cancelation of a payment on the payment gateway. The order will go back to the
|
||||
* "not paid" status.
|
||||
*
|
||||
* @param int $order_id the order ID
|
||||
*/
|
||||
public function cancelPayment($order_id)
|
||||
{
|
||||
$order_id = intval($order_id);
|
||||
|
||||
if (null !== $order = $this->getOrder($order_id)) {
|
||||
$this->getLog()->addInfo(
|
||||
$this->getTranslator()->trans(
|
||||
"Processing cancelation of payment for order ref. %ref",
|
||||
array('%ref' => $order->getRef())
|
||||
)
|
||||
);
|
||||
|
||||
$event = new OrderEvent($order);
|
||||
|
||||
$event->setStatus(OrderStatus::CODE_NOT_PAID);
|
||||
|
||||
$this->getLog()->addInfo(
|
||||
$this->getTranslator()->trans(
|
||||
"Order ref. %ref is now unpaid.",
|
||||
array('%ref' => $order->getRef())
|
||||
)
|
||||
);
|
||||
|
||||
$this->dispatch(TheliaEvents::ORDER_UPDATE_STATUS, $event);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an order and issue a log message if not found.
|
||||
* @param $order_id
|
||||
* @return null|\Thelia\Model\Order
|
||||
*/
|
||||
protected function getOrder($order_id)
|
||||
{
|
||||
if (null == $order = OrderQuery::create()->findPk($order_id)) {
|
||||
$this->getLog()->addError(
|
||||
$this->getTranslator()->trans("Unknown order ID: %id", array('%id' => $order_id))
|
||||
);
|
||||
}
|
||||
|
||||
return $order;
|
||||
}
|
||||
/**
|
||||
* Redirect the customer to the successful payment page.
|
||||
*
|
||||
* @param int $order_id the order ID
|
||||
*/
|
||||
public function redirectToSuccessPage($order_id)
|
||||
{
|
||||
$this->getLog()->addInfo("Redirecting customer to payment success page");
|
||||
|
||||
throw new RedirectException(
|
||||
$this->retrieveUrlFromRouteId(
|
||||
'order.placed',
|
||||
[],
|
||||
[
|
||||
'order_id' => $order_id
|
||||
],
|
||||
Router::ABSOLUTE_PATH
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Redirect the customer to the failure payment page. if $message is null, a generic message is displayed.
|
||||
*
|
||||
* @param int $order_id the order ID
|
||||
* @param string|null $message an error message.
|
||||
*/
|
||||
public function redirectToFailurePage($order_id, $message)
|
||||
{
|
||||
$this->getLog()->addInfo("Redirecting customer to payment failure page");
|
||||
|
||||
throw new RedirectException(
|
||||
$this->retrieveUrlFromRouteId(
|
||||
'order.failed',
|
||||
[],
|
||||
[
|
||||
'order_id' => $order_id,
|
||||
'message' => $message
|
||||
],
|
||||
Router::ABSOLUTE_PATH
|
||||
)
|
||||
);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user