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

Fixed some more method comments

Browse Source
This commit is contained in:
Franck Allimant
2014-06-30 19:30:00 +02:00
parent e972a4be60
commit 4f7f26380a
1 changed files with 22 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -15,6 +15,7 @@ namespace Thelia\Controller\Front;
use Symfony\Component\Routing\Router; use Symfony\Component\Routing\Router;
use Thelia\Controller\BaseController; use Thelia\Controller\BaseController;
use Thelia\Core\HttpFoundation\Response; use Thelia\Core\HttpFoundation\Response;
use Thelia\Core\Template\ParserInterface;
use Thelia\Core\Template\TemplateDefinition; use Thelia\Core\Template\TemplateDefinition;
use Thelia\Core\Template\TemplateHelper; use Thelia\Core\Template\TemplateHelper;
use Thelia\Model\AddressQuery; use Thelia\Model\AddressQuery;
@@ -30,17 +31,30 @@ class BaseFrontController extends BaseController
* *
* @see \Thelia\Controller\BaseController::getRouteFromRouter() * @see \Thelia\Controller\BaseController::getRouteFromRouter()
*/ */
/**
* Return the route path defined for the givent route ID
*
* @param string $routeId the route ID, as found in Config/Resources/routing/admin.xml
* @param array $parameters the Route parameters, as a var/value pair array
* @param bool $referenceType Router::ABSOLUTE_PATH or Router::ABSOLUTE_URL
*
* @see \Thelia\Controller\BaseController::getRouteFromRouter()
*
* @return string the route path
*/
protected function getRoute($routeId, $parameters = array(), $referenceType = Router::ABSOLUTE_PATH) protected function getRoute($routeId, $parameters = array(), $referenceType = Router::ABSOLUTE_PATH)
{ {
return $this->getRouteFromRouter('router.front', $routeId, $parameters, $referenceType); return $this->getRouteFromRouter('router.front', $routeId, $parameters, $referenceType);
} }
/** /**
* Redirect to à route ID related URL * Redirect to a specific route.
* *
* @param string $routeId the route ID, as found in Config/Resources/routing/admin.xml * @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 array $urlParameters the URL parameters, as a var/value pair array
* @param bool $referenceType * @param array $routeParameters the Route parameters, as a var/value pair array
* @param bool $referenceType Router::ABSOLUTE_PATH or Router::ABSOLUTE_URL
*/ */
public function redirectToRoute($routeId, array $urlParameters = [], array $routeParameters = [], $referenceType = Router::ABSOLUTE_PATH) public function redirectToRoute($routeId, array $urlParameters = [], array $routeParameters = [], $referenceType = Router::ABSOLUTE_PATH)
{ {
@@ -95,7 +109,9 @@ class BaseFrontController extends BaseController
} }
/** /**
* @return TemplateDefinition the template * @param TemplateDefinition $template the template to process, or null for using the front template
*
* @return ParserInterface the Thelia parser²
*/ */
protected function getParser($template = null) protected function getParser($template = null)
{ {