TheCoreDev/sterivein
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #282 from roadster31/basemodulecontroller

Browse Source 
Standard pages and enhancements for payment modules
This commit is contained in:
Manuel Raynaud
2014-04-11 09:34:51 +02:00
parent 334ebf12f5 8427cb1061
commit 441ac3dc2a
11 changed files with 271 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
core/lib/Thelia/Controller/Front/BaseFrontController.php
View File

@@ -48,9 +48,9 @@ class BaseFrontController extends BaseController
/**
* Redirect to à route ID related URL
*
* @param unknown $routeId the route ID, as found in Config/Resources/routing/admin.xml
* @param array|\Thelia\Controller\Front\unknown $urlParameters the URL parametrs, as a var/value pair array
* @param bool $referenceType
* @param string $routeId the route ID, as found in Config/Resources/routing/admin.xml
* @param array $urlParameters the URL parametrs, as a var/value pair array
* @param bool $referenceType
*/
public function redirectToRoute($routeId, $urlParameters = array(), $referenceType = Router::ABSOLUTE_PATH)
{
@@ -104,7 +104,7 @@ class BaseFrontController extends BaseController
/**
* Render the given template, and returns the result as an Http Response.
*
* @param $templateName the complete template name, with extension
* @param string $templateName the complete template name, with extension
* @param array $args the template arguments
* @param int $status http code status
* @return \Thelia\Core\HttpFoundation\Response

9
core/lib/Thelia/Core/Template/ParserInterface.php
View File

@@ -38,6 +38,13 @@ interface ParserInterface
public function setStatus($status);
/**
* Setup the parser with a template definition, which provides a template description.
*
* @param TemplateDefinition $templateDefinition
*/
public function setTemplateDefinition(TemplateDefinition $templateDefinition);
/**
* Add a template directory to the current template list
*
@@ -54,7 +61,7 @@ interface ParserInterface
* Return the registeted template directories for a givent template type
*
* @param unknown $templateType
* @throws InvalidArgumentException if the tempmateType is not defined
* @throws \InvalidArgumentException if the templateType is not defined
* @return array: an array of defined templates directories for the given template type
*/
public function getTemplateDirectories($templateType);

8
core/lib/Thelia/Core/Template/Smarty/SmartyParser.php
View File

@@ -92,11 +92,11 @@ class SmartyParser extends Smarty implements ParserInterface
/**
* Add a template directory to the current template list
*
* @param unknown $templateType the template type (a TemplateDefinition type constant)
* @param int $templateType the template type (a TemplateDefinition type constant)
* @param string $templateName the template name
* @param string $templateDirectory path to the template dirtectory
* @param unknown $key ???
* @param string $unshift ??? Etienne ?
* @param boolean $unshift ??? Etienne ?
*/
public function addTemplateDirectory($templateType, $templateName, $templateDirectory, $key, $unshift = false)
{
@@ -116,9 +116,9 @@ class SmartyParser extends Smarty implements ParserInterface
/**
* Return the registeted template directories for a givent template type
*
* @param unknown $templateType
* @param int $templateType
* @throws InvalidArgumentException
* @return multitype:
* @return mixed:
*/
public function getTemplateDirectories($templateType)
{

13
core/lib/Thelia/Log/Tlog.php
View File

@@ -124,6 +124,19 @@ class Tlog Implements LoggerInterface
return self::$instance;
}
/**
* Create a new Tlog instance, that could be configured without interfering with the "main" instance
*
* @return Tlog a new Tlog instance.
*/
public static function getNewInstance() {
$instance = new Tlog();
$instance->init();
return $instance;
}
/**
* initialize default configuration
*/

132
core/lib/Thelia/Module/AbstractPaymentModule.php Normal file
View File

@@ -0,0 +1,132 @@
<?php
/*************************************************************************************/
/* */
/* Thelia */
/* */
/* Copyright (c) OpenStudio */
/* email : info@thelia.net */
/* web : http://www.thelia.net */
/* */
/* This program is free software; you can redistribute it and/or modify */
/* it under the terms of the GNU General Public License as published by */
/* the Free Software Foundation; either version 3 of the License */
/* */
/* This program is distributed in the hope that it will be useful, */
/* but WITHOUT ANY WARRANTY; without even the implied warranty of */
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* along with this program. If not, see <http://www.gnu.org/licenses/>. */
/* */
/*************************************************************************************/
namespace Thelia\Module;
use Symfony\Component\Routing\Router;
use Thelia\Core\HttpFoundation\Response;
use Thelia\Core\Template\ParserInterface;
use Thelia\Core\Template\TemplateHelper;
use Thelia\Exception\TheliaProcessException;
use Thelia\Model\Order;
use Thelia\Tools\URL;
abstract class AbstractPaymentModule extends BaseModule implements PaymentModuleInterface
{
/**
* This method is called when the payement gateway needs to be invoked.
*
* If this method return a Response instance, this response is sent to the browser. Return null if you don't want to
* send a response and process the payment yourself.
*
* 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, instead of redirecting. The generateGatewayFormResponse() may help you in this case :)
*
* @param Order $order processed order
* @return null|Response
*/
abstract public function pay(Order $order);
/**
* This method is called by the Payment loop, to check if the current module has to be displayed to the customer
*
* If you return true, the payment method will de displayed to the customed
* If you return false, the payment method will not be displayed
*
* @return boolean
*/
abstract public function isValidPayment();
/**
* Render the payment gateway template. The module should provide the gateway URL and the form fields names and values.
*
* @param Order $order the order
* @param string $gateway_url the payment gateway URL
* @param array $form_data an associative array of form data, that will be rendered as hiddent fields
*
* @return Response the HTTP response.
*/
public function generateGatewayFormResponse($order, $gateway_url, $form_data)
{
/** @var ParserInterface $parser */
$parser = $this->container->get("thelia.parser");
$parser->setTemplateDefinition(TemplateHelper::getInstance()->getActiveFrontTemplate());
$renderedTemplate = $parser->render(
"order-payment-gateway.html",
array(
"order_id" => $order->getId(),
"cart_count" => $this->getRequest()->getSession()->getCart()->getCartItems()->count(),
"gateway_url" => $gateway_url,
"payment_form_data" => $form_data
)
);
return Response::create($renderedTemplate);
}
/**
* Return the order payment success page URL
*
* @param int $order_id the order ID
* @return string the order payment success page URL
*/
public function getPayementSuccessPageUrl($order_id)
{
$frontOfficeRouter = $this->container->get('router.front');
return URL::getInstance()->absoluteUrl(
$frontOfficeRouter->generate(
"order.placed",
array("order_id" => $order_id),
Router::ABSOLUTE_URL
)
);
}
/**
* 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.
*
* @return string the order payment failure page URL
*/
public function getPayementFailurePageUrl($order_id, $message)
{
$frontOfficeRouter = $this->container->get('router.front');
return URL::getInstance()->absoluteUrl(
$frontOfficeRouter->generate(
"order.failed",
array(
"order_id" => $order_id,
"message" => $message
),
Router::ABSOLUTE_URL
)
);
}
}