dinislage/PrestaShop
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

// code norm

Browse Source 
git-svn-id: http://dev.prestashop.com/svn/v1/branches/1.5.x@8545 b9a71923-0436-4b27-9f14-aed3839534dd
This commit is contained in:
fBrignoli
2011-09-13 16:55:44 +00:00
parent 0c49b5b416
commit d74bcee308
1 changed files with 73 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/Dispatcher.php
+47 -47
View File
@@ -40,7 +40,7 @@ class DispatcherCore
* *
* @var array * @var array
*/ */
public $defaultRoutes = array( public $default_routes = array(
'product_rule' => array( 'product_rule' => array(
'controller' => 'product', 'controller' => 'product',
'rule' => '{category:/}{id}-{rewrite}{-:ean13}.html', 'rule' => '{category:/}{id}-{rewrite}{-:ean13}.html',
@@ -115,7 +115,7 @@ class DispatcherCore
* *
* @var bool * @var bool
*/ */
protected $useRoutes = false; protected $use_routes = false;
/** /**
* List of loaded routes * List of loaded routes
@@ -136,14 +136,14 @@ class DispatcherCore
* *
* @var string * @var string
*/ */
protected $requestURI; protected $request_uri;
/** /**
* Store empty route (a route with an empty rule) * Store empty route (a route with an empty rule)
* *
* @var array * @var array
*/ */
protected $emptyRoute; protected $empty_route;
/** /**
* Get current instance of dispatcher (singleton) * Get current instance of dispatcher (singleton)
@@ -162,14 +162,14 @@ class DispatcherCore
*/ */
protected function __construct() protected function __construct()
{ {
$this->useRoutes = (bool)Configuration::get('PS_REWRITING_SETTINGS'); $this->use_routes = (bool)Configuration::get('PS_REWRITING_SETTINGS');
$this->loadRoutes(); $this->loadRoutes();
// Get request uri (HTTP_X_REWRITE_URL is used by IIS) // Get request uri (HTTP_X_REWRITE_URL is used by IIS)
if (isset($_SERVER['REQUEST_URI'])) if (isset($_SERVER['request_uri']))
$this->requestURI = $_SERVER['REQUEST_URI']; $this->request_uri = $_SERVER['request_uri'];
else if (isset($_SERVER['HTTP_X_REWRITE_URL'])) else if (isset($_SERVER['HTTP_X_REWRITE_URL']))
$this->requestURI = $_SERVER['HTTP_X_REWRITE_URL']; $this->request_uri = $_SERVER['HTTP_X_REWRITE_URL'];
} }
/** /**
@@ -177,14 +177,14 @@ class DispatcherCore
*/ */
public function dispatch() public function dispatch()
{ {
$this->requestURI = preg_replace('#^'.preg_quote(Context::getContext()->shop->getBaseURI(), '#').'#i', '/', $this->requestURI); $this->request_uri = preg_replace('#^'.preg_quote(Context::getContext()->shop->getBaseURI(), '#').'#i', '/', $this->request_uri);
// If there are several languages, get language from uri // If there are several languages, get language from uri
if ($this->useRoutes && Language::isMultiLanguageActivated()) if ($this->use_routes && Language::isMultiLanguageActivated())
if (preg_match('#^/([a-z]{2})/#', $this->requestURI, $m)) if (preg_match('#^/([a-z]{2})/#', $this->request_uri, $m))
{ {
$_GET['isolang'] = $m[1]; $_GET['isolang'] = $m[1];
$this->requestURI = substr($this->requestURI, 3); $this->request_uri = substr($this->request_uri, 3);
} }
// Get and instantiate controller // Get and instantiate controller
$this->getController(); $this->getController();
@@ -202,10 +202,10 @@ class DispatcherCore
protected function loadRoutes() protected function loadRoutes()
{ {
$context = Context::getContext(); $context = Context::getContext();
foreach ($this->defaultRoutes as $id => $route) foreach ($this->default_routes as $id => $route)
$this->addRoute($id, $route['rule'], $route['controller'], $route['keywords']); $this->addRoute($id, $route['rule'], $route['controller'], $route['keywords']);
if ($this->useRoutes) if ($this->use_routes)
{ {
// Load routes from meta table // Load routes from meta table
$sql = 'SELECT m.page, ml.url_rewrite $sql = 'SELECT m.page, ml.url_rewrite
@@ -219,7 +219,7 @@ class DispatcherCore
if ($row['url_rewrite']) if ($row['url_rewrite'])
$this->addRoute($row['page'], $row['url_rewrite'], $row['page']); $this->addRoute($row['page'], $row['url_rewrite'], $row['page']);
else else
$this->emptyRoute = array( $this->empty_route = array(
'routeID' => $row['page'], 'routeID' => $row['page'],
'rule' => $row['url_rewrite'], 'rule' => $row['url_rewrite'],
'controller' => $row['page'], 'controller' => $row['page'],
@@ -227,9 +227,9 @@ class DispatcherCore
} }
// Load custom routes // Load custom routes
foreach ($this->defaultRoutes as $routeID => $routeData) foreach ($this->default_routes as $route_id => $route_data)
if ($customRoute = Configuration::get('PS_ROUTE_'.$routeID)) if ($custom_route = Configuration::get('PS_ROUTE_'.$route_id))
$this->addRoute($routeID, $customRoute, $routeData['controller'], $routeData['keywords']); $this->addRoute($route_id, $custom_route, $route_data['controller'], $route_data['keywords']);
} }
} }
@@ -239,19 +239,19 @@ class DispatcherCore
* @param string $rule Url rule * @param string $rule Url rule
* @param string $controller Controller to call if request uri match the rule * @param string $controller Controller to call if request uri match the rule
*/ */
public function addRoute($routeID, $rule, $controller, $keywords = array()) public function addRoute($route_id, $rule, $controller, $keywords = array())
{ {
$regexp = preg_quote($rule, '#'); $regexp = preg_quote($rule, '#');
if ($keywords) if ($keywords)
{ {
$transformKeywords = array(); $transform_keywords = array();
preg_match_all('#\\\{(([^{}]+)\\\:)?('.implode('|', array_keys($keywords)).')(\\\:([^{}]+))?\\\}#', $regexp, $m); preg_match_all('#\\\{(([^{}]+)\\\:)?('.implode('|', array_keys($keywords)).')(\\\:([^{}]+))?\\\}#', $regexp, $m);
for ($i = 0, $total = count($m[0]); $i < $total; $i++) for ($i = 0, $total = count($m[0]); $i < $total; $i++)
{ {
$prepend = $m[2][$i]; $prepend = $m[2][$i];
$keyword = $m[3][$i]; $keyword = $m[3][$i];
$append = $m[5][$i]; $append = $m[5][$i];
$transformKeywords[$keyword] = array( $transform_keywords[$keyword] = array(
'required' => isset($keywords[$keyword]['param']), 'required' => isset($keywords[$keyword]['param']),
'prepend' => stripslashes($prepend), 'prepend' => stripslashes($prepend),
'append' => stripslashes($append), 'append' => stripslashes($append),
@@ -263,11 +263,11 @@ class DispatcherCore
$regexp = str_replace($m[0][$i], (($prepend) ? '('.$prepend.')?' : '').'('.$keywords[$keyword]['regexp'].')'.(($append) ? '('.$append.')?' : ''), $regexp); $regexp = str_replace($m[0][$i], (($prepend) ? '('.$prepend.')?' : '').'('.$keywords[$keyword]['regexp'].')'.(($append) ? '('.$append.')?' : ''), $regexp);
} }
$keywords = $transformKeywords; $keywords = $transform_keywords;
} }
$regexp = '#^/'.$regexp.'#'; $regexp = '#^/'.$regexp.'#';
$this->routes[$routeID] = array( $this->routes[$route_id] = array(
'rule' => $rule, 'rule' => $rule,
'regexp' => $regexp, 'regexp' => $regexp,
'controller' => $controller, 'controller' => $controller,
@@ -278,32 +278,32 @@ class DispatcherCore
/** /**
* Check if a keyword is written in a route rule * Check if a keyword is written in a route rule
* *
* @param string $routeID * @param string $route_id
* @param string $keyword * @param string $keyword
* @return bool * @return bool
*/ */
public function hasKeyword($routeID, $keyword) public function hasKeyword($route_id, $keyword)
{ {
if (!isset($this->routes[$routeID])) if (!isset($this->routes[$route_id]))
return false; return false;
return preg_match('#\{([^{}]+:)?'.preg_quote($keyword, '#').'(:[^{}])?\}#', $this->routes[$routeID]['rule']); return preg_match('#\{([^{}]+:)?'.preg_quote($keyword, '#').'(:[^{}])?\}#', $this->routes[$route_id]['rule']);
} }
/** /**
* Check if a route rule contain all required keywords of default route definition * Check if a route rule contain all required keywords of default route definition
* *
* @param string $routeID * @param string $route_id
* @param string $rule Rule to verify * @param string $rule Rule to verify
* @param array $errors List of missing keywords * @param array $errors List of missing keywords
*/ */
public function validateRoute($routeID, $rule, &$errors = array()) public function validateRoute($route_id, $rule, &$errors = array())
{ {
$errors = array(); $errors = array();
if (!isset($this->defaultRoutes[$routeID])) if (!isset($this->default_routes[$route_id]))
return false; return false;
foreach ($this->defaultRoutes[$routeID]['keywords'] as $keyword => $data) foreach ($this->default_routes[$route_id]['keywords'] as $keyword => $data)
if (isset($data['param']) && !preg_match('#\{([^{}]+:)?'.$keyword.'(:[^{}])?\}#', $rule)) if (isset($data['param']) && !preg_match('#\{([^{}]+:)?'.$keyword.'(:[^{}])?\}#', $rule))
$errors[] = $keyword; $errors[] = $keyword;
@@ -313,36 +313,36 @@ class DispatcherCore
/** /**
* Create an url from * Create an url from
* *
* @param string $routeID Name the route * @param string $route_id Name the route
* @param array $params * @param array $params
* @param bool $useRoutes If false, don't use to create this url * @param bool $use_routes If false, don't use to create this url
*/ */
public function createUrl($routeID, $params = array(), $useRoutes = true) public function createUrl($route_id, $params = array(), $use_routes = true)
{ {
if (!is_array($params)) if (!is_array($params))
die('Dispatcher::createUrl() $params must be an array'); die('Dispatcher::createUrl() $params must be an array');
if (!isset($this->routes[$routeID])) if (!isset($this->routes[$route_id]))
{ {
$query = http_build_query($params); $query = http_build_query($params);
return ($routeID == 'index') ? 'index.php'.(($query) ? '?'.$query : '') : 'index.php?controller='.$routeID.(($query) ? '&amp;'.$query : ''); return ($route_id == 'index') ? 'index.php'.(($query) ? '?'.$query : '') : 'index.php?controller='.$route_id.(($query) ? '&amp;'.$query : '');
} }
$route = $this->routes[$routeID]; $route = $this->routes[$route_id];
// Check required fields // Check required fields
$queryParams = array(); $query_params = array();
foreach ($route['keywords'] as $key => $data) foreach ($route['keywords'] as $key => $data)
{ {
if (!$data['required']) if (!$data['required'])
continue; continue;
if (!array_key_exists($key, $params)) if (!array_key_exists($key, $params))
die("Dispatcher::createUrl() miss required parameter '$key' for route '$routeID'"); die('Dispatcher::createUrl() miss required parameter "'.$key.'" for route "'.$route_id.'"');
$queryParams[$this->defaultRoutes[$routeID]['keywords'][$key]['param']] = $params[$key]; $query_params[$this->default_routes[$route_id]['keywords'][$key]['param']] = $params[$key];
} }
// Build an url which match a route // Build an url which match a route
if ($this->useRoutes && $useRoutes) if ($this->use_routes && $use_routes)
{ {
$url = $route['rule']; $url = $route['rule'];
foreach ($params as $key => $value) foreach ($params as $key => $value)
@@ -360,7 +360,7 @@ class DispatcherCore
} }
// Build a classic url index.php?controller=foo&... // Build a classic url index.php?controller=foo&...
else else
$url = 'index.php?controller='.$route['controller'].(($queryParams) ? '&amp;'.http_build_query($queryParams) : ''); $url = 'index.php?controller='.$route['controller'].(($query_params) ? '&amp;'.http_build_query($query_params) : '');
return $url; return $url;
} }
@@ -387,18 +387,18 @@ class DispatcherCore
} }
// Use routes ? (for url rewriting) // Use routes ? (for url rewriting)
if ($this->useRoutes && !$controller) if ($this->use_routes && !$controller)
{ {
if (!$this->requestURI) if (!$this->request_uri)
return 'pagenotfound'; return 'pagenotfound';
$controller = 'index'; $controller = 'index';
// Add empty route as last route to prevent this greedy regexp to match request uri before right time // Add empty route as last route to prevent this greedy regexp to match request uri before right time
if ($this->emptyRoute) if ($this->empty_route)
$this->addRoute($this->emptyRoute['routeID'], $this->emptyRoute['rule'], $this->emptyRoute['controller']); $this->addRoute($this->empty_route['routeID'], $this->empty_route['rule'], $this->empty_route['controller']);
foreach ($this->routes as $route) foreach ($this->routes as $route)
if (preg_match($route['regexp'], $this->requestURI, $m)) if (preg_match($route['regexp'], $this->request_uri, $m))
{ {
// Route found ! Now fill $_GET with parameters of uri // Route found ! Now fill $_GET with parameters of uri
$controller = $route['controller']; $controller = $route['controller'];