web/lib/Zend/Controller/Router/Rewrite.php
changeset 1230 68c69c656a2c
parent 807 877f952ae2bd
--- a/web/lib/Zend/Controller/Router/Rewrite.php	Thu May 07 15:10:09 2015 +0200
+++ b/web/lib/Zend/Controller/Router/Rewrite.php	Thu May 07 15:16:02 2015 +0200
@@ -15,8 +15,8 @@
  * @category   Zend
  * @package    Zend_Controller
  * @subpackage Router
- * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- * @version    $Id: Rewrite.php 24593 2012-01-05 20:35:02Z matthew $
+ * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
+ * @version    $Id$
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
 
@@ -31,7 +31,7 @@
  *
  * @package    Zend_Controller
  * @subpackage Router
- * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  * @see        http://manuals.rubyonrails.com/read/chapter/65
  */
@@ -55,7 +55,7 @@
     /**
      * Currently matched route
      *
-     * @var Zend_Controller_Router_Route_Interface
+     * @var string
      */
     protected $_currentRoute = null;
 
@@ -90,7 +90,7 @@
     {
         if (!$this->hasRoute('default')) {
             $dispatcher = $this->getFrontController()->getDispatcher();
-            $request = $this->getFrontController()->getRequest();
+            $request    = $this->getFrontController()->getRequest();
 
             require_once 'Zend/Controller/Router/Route/Module.php';
             $compat = new Zend_Controller_Router_Route_Module(array(), $dispatcher, $request);
@@ -106,8 +106,8 @@
      *
      * If route contains method setRequest(), it is initialized with a request object
      *
-     * @param  string                                 $name       Name of the route
-     * @param  Zend_Controller_Router_Route_Interface $route      Instance of the route
+     * @param  string                                 $name  Name of the route
+     * @param  Zend_Controller_Router_Route_Interface $route Instance of the route
      * @return Zend_Controller_Router_Rewrite
      */
     public function addRoute($name, Zend_Controller_Router_Route_Interface $route)
@@ -127,7 +127,8 @@
      * @param  array $routes Array of routes with names as keys and routes as values
      * @return Zend_Controller_Router_Rewrite
      */
-    public function addRoutes($routes) {
+    public function addRoutes($routes)
+    {
         foreach ($routes as $name => $route) {
             $this->addRoute($name, $route);
         }
@@ -215,7 +216,12 @@
             Zend_Loader::loadClass($class);
         }
 
-        $route = call_user_func(array($class, 'getInstance'), $info);
+        $route = call_user_func(
+            array(
+                $class,
+                'getInstance'
+            ), $info
+        );
 
         if (isset($info->abstract) && $info->abstract && method_exists($route, 'isAbstract')) {
             $route->isAbstract(true);
@@ -232,9 +238,11 @@
      * @param  Zend_Config                            $childRoutesInfo
      * @return void
      */
-    protected function _addChainRoutesFromConfig($name,
-                                                 Zend_Controller_Router_Route_Interface $route,
-                                                 Zend_Config $childRoutesInfo)
+    protected function _addChainRoutesFromConfig(
+        $name,
+        Zend_Controller_Router_Route_Interface $route,
+        Zend_Config $childRoutesInfo
+    )
     {
         foreach ($childRoutesInfo as $childRouteName => $childRouteInfo) {
             if (is_string($childRouteInfo)) {
@@ -283,7 +291,6 @@
     /**
      * Remove all standard default routes
      *
-     * @param  Zend_Controller_Router_Route_Interface Route
      * @return Zend_Controller_Router_Rewrite
      */
     public function removeDefaultRoutes()
@@ -333,6 +340,7 @@
             require_once 'Zend/Controller/Router/Exception.php';
             throw new Zend_Controller_Router_Exception("Current route is not defined");
         }
+
         return $this->getRoute($this->_currentRoute);
     }
 
@@ -340,7 +348,7 @@
      * Retrieve a name of currently matched route
      *
      * @throws Zend_Controller_Router_Exception
-     * @return Zend_Controller_Router_Route_Interface Route object
+     * @return string Route name
      */
     public function getCurrentRouteName()
     {
@@ -348,6 +356,7 @@
             require_once 'Zend/Controller/Router/Exception.php';
             throw new Zend_Controller_Router_Exception("Current route is not defined");
         }
+
         return $this->_currentRoute;
     }
 
@@ -365,6 +374,7 @@
      * Find a matching route to the current PATH_INFO and inject
      * returning values to the Request object.
      *
+     * @param Zend_Controller_Request_Abstract $request
      * @throws Zend_Controller_Router_Exception
      * @return Zend_Controller_Request_Abstract Request object
      */
@@ -372,7 +382,9 @@
     {
         if (!$request instanceof Zend_Controller_Request_Http) {
             require_once 'Zend/Controller/Router/Exception.php';
-            throw new Zend_Controller_Router_Exception('Zend_Controller_Router_Rewrite requires a Zend_Controller_Request_Http-based request object');
+            throw new Zend_Controller_Router_Exception(
+                'Zend_Controller_Router_Rewrite requires a Zend_Controller_Request_Http-based request object'
+            );
         }
 
         if ($this->_useDefaultRoutes) {
@@ -403,22 +415,29 @@
             }
         }
 
-         if (!$routeMatched) {
-             require_once 'Zend/Controller/Router/Exception.php';
-             throw new Zend_Controller_Router_Exception('No route matched the request', 404);
-         }
+        if (!$routeMatched) {
+            require_once 'Zend/Controller/Router/Exception.php';
+            throw new Zend_Controller_Router_Exception('No route matched the request', 404);
+        }
 
-        if($this->_useCurrentParamsAsGlobal) {
+        if ($this->_useCurrentParamsAsGlobal) {
             $params = $request->getParams();
-            foreach($params as $param => $value) {
+            foreach ($params as $param => $value) {
                 $this->setGlobalParam($param, $value);
             }
         }
 
         return $request;
-
     }
 
+    /**
+     * Sets parameters for request object
+     *
+     * Module name, controller name and action name
+     *
+     * @param Zend_Controller_Request_Abstract $request
+     * @param array                            $params
+     */
     protected function _setRequestParams($request, $params)
     {
         foreach ($params as $param => $value) {
@@ -434,7 +453,6 @@
             if ($param === $request->getActionKey()) {
                 $request->setActionName($value);
             }
-
         }
     }
 
@@ -442,9 +460,9 @@
      * Generates a URL path that can be used in URL creation, redirection, etc.
      *
      * @param  array $userParams Options passed by a user used to override parameters
-     * @param  mixed $name The name of a Route to use
-     * @param  bool $reset Whether to reset to the route defaults ignoring URL params
-     * @param  bool $encode Tells to encode URL parts on output
+     * @param  mixed $name       The name of a Route to use
+     * @param  bool  $reset      Whether to reset to the route defaults ignoring URL params
+     * @param  bool  $encode     Tells to encode URL parts on output
      * @throws Zend_Controller_Router_Exception
      * @return string Resulting absolute URL path
      */
@@ -454,7 +472,7 @@
             require_once 'Zend/Controller/Router/Exception.php';
             throw new Zend_Controller_Router_Exception('userParams must be an array');
         }
-        
+
         if ($name == null) {
             try {
                 $name = $this->getCurrentRouteName();
@@ -480,7 +498,7 @@
      * Set a global parameter
      *
      * @param  string $name
-     * @param  mixed $value
+     * @param  mixed  $value
      * @return Zend_Controller_Router_Rewrite
      */
     public function setGlobalParam($name, $value)
@@ -496,7 +514,8 @@
      * @param string $separator The separator to use
      * @return Zend_Controller_Router_Rewrite
      */
-    public function setChainNameSeparator($separator) {
+    public function setChainNameSeparator($separator)
+    {
         $this->_chainNameSeparator = $separator;
 
         return $this;
@@ -507,7 +526,8 @@
      *
      * @return string
      */
-    public function getChainNameSeparator() {
+    public function getChainNameSeparator()
+    {
         return $this->_chainNameSeparator;
     }
 
@@ -515,19 +535,20 @@
      * Determines/returns whether to use the request parameters as global parameters.
      *
      * @param boolean|null $use
-     *           Null/unset when you want to retrieve the current state.
-     *           True when request parameters should be global, false otherwise
+     *              Null/unset when you want to retrieve the current state.
+     *              True when request parameters should be global, false otherwise
      * @return boolean|Zend_Controller_Router_Rewrite
      *              Returns a boolean if first param isn't set, returns an
      *              instance of Zend_Controller_Router_Rewrite otherwise.
      *
      */
-    public function useRequestParametersAsGlobal($use = null) {
-        if($use === null) {
+    public function useRequestParametersAsGlobal($use = null)
+    {
+        if ($use === null) {
             return $this->_useCurrentParamsAsGlobal;
         }
 
-        $this->_useCurrentParamsAsGlobal = (bool) $use;
+        $this->_useCurrentParamsAsGlobal = (bool)$use;
 
         return $this;
     }