web/lib/Zend/Controller/Router/Interface.php
changeset 1230 68c69c656a2c
parent 807 877f952ae2bd
equal deleted inserted replaced
1229:5a6b6e770365 1230:68c69c656a2c
    13  * to license@zend.com so we can send you a copy immediately.
    13  * to license@zend.com so we can send you a copy immediately.
    14  *
    14  *
    15  * @category   Zend
    15  * @category   Zend
    16  * @package    Zend_Controller
    16  * @package    Zend_Controller
    17  * @subpackage Router
    17  * @subpackage Router
    18  * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
    18  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
    19  * @license    http://framework.zend.com/license/new-bsd     New BSD License
    19  * @license    http://framework.zend.com/license/new-bsd     New BSD License
    20  * @version    $Id: Interface.php 24593 2012-01-05 20:35:02Z matthew $
    20  * @version    $Id$
    21  */
    21  */
    22 
    22 
    23 /**
    23 /**
    24  * @package    Zend_Controller
    24  * @package    Zend_Controller
    25  * @subpackage Router
    25  * @subpackage Router
    26  * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
    26  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
    27  * @license    http://framework.zend.com/license/new-bsd     New BSD License
    27  * @license    http://framework.zend.com/license/new-bsd     New BSD License
    28  */
    28  */
    29 interface Zend_Controller_Router_Interface
    29 interface Zend_Controller_Router_Interface
    30 {
    30 {
    31     /**
    31     /**
    52      * Ignoring all URL specified values. User specified params still get precedence.
    52      * Ignoring all URL specified values. User specified params still get precedence.
    53      *
    53      *
    54      * Encode tells to url encode resulting path parts.
    54      * Encode tells to url encode resulting path parts.
    55      *
    55      *
    56      * @param  array $userParams Options passed by a user used to override parameters
    56      * @param  array $userParams Options passed by a user used to override parameters
    57      * @param  mixed $name The name of a Route to use
    57      * @param  mixed $name       The name of a Route to use
    58      * @param  bool $reset Whether to reset to the route defaults ignoring URL params
    58      * @param  bool  $reset      Whether to reset to the route defaults ignoring URL params
    59      * @param  bool $encode Tells to encode URL parts on output
    59      * @param  bool  $encode     Tells to encode URL parts on output
    60      * @throws Zend_Controller_Router_Exception
    60      * @throws Zend_Controller_Router_Exception
    61      * @return string Resulting URL path
    61      * @return string Resulting URL path
    62      */
    62      */
    63     public function assemble($userParams, $name = null, $reset = false, $encode = true);
    63     public function assemble($userParams, $name = null, $reset = false, $encode = true);
    64 
    64 
    79 
    79 
    80     /**
    80     /**
    81      * Add or modify a parameter with which to instantiate any helper objects
    81      * Add or modify a parameter with which to instantiate any helper objects
    82      *
    82      *
    83      * @param string $name
    83      * @param string $name
    84      * @param mixed $param
    84      * @param mixed  $value
    85      * @return Zend_Controller_Router_Interface
    85      * @return Zend_Controller_Router_Interface
    86      */
    86      */
    87     public function setParam($name, $value);
    87     public function setParam($name, $value);
    88 
    88 
    89     /**
    89     /**
   118      *
   118      *
   119      * @param null|string|array single key or array of keys for params to clear
   119      * @param null|string|array single key or array of keys for params to clear
   120      * @return Zend_Controller_Router_Interface
   120      * @return Zend_Controller_Router_Interface
   121      */
   121      */
   122     public function clearParams($name = null);
   122     public function clearParams($name = null);
   123 
       
   124 }
   123 }