API Documentation

Zend/Controller/Router/Interface.php

Show: inherited
    Table of Contents

    Zend Framework

    LICENSE

    This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

    Category
    Zend  
    Copyright
    Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  
    Package
    Zend_Controller  
    Subpackage
    Router  
    Version
    $Id: Interface.php 24594 2012-01-05 21:27:01Z matthew $  

    \Zend_Controller_Router_Interface

    Package: Zend\Controller\Router

    Copyright
    Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  

    Methods

    methodpublicassemble( array $userParams, mixed $name = null, bool $reset = false, bool $encode = true ) : string

    Generates a URL path that can be used in URL creation, redirection, etc.

    May be passed user params to override ones from URI, Request or even defaults. If passed parameter has a value of null, it's URL variable will be reset to default.

    If null is passed as a route name assemble will use the current Route or 'default' if current is not yet set.

    Reset is used to signal that all parameters should be reset to it's defaults. Ignoring all URL specified values. User specified params still get precedence.

    Encode tells to url encode resulting path parts.

    Parameters
    Name Type Description
    $userParams array

    Options passed by a user used to override parameters

    $name mixed

    The name of a Route to use

    $reset bool

    Whether to reset to the route defaults ignoring URL params

    $encode bool

    Tells to encode URL parts on output

    Returns
    Type Description
    string Resulting URL path
    Throws
    Exception Description
    \Zend_Controller_Router_Exception
    methodpublicclearParams( null|string|array $name = null ) : \Zend_Controller_Router_Interface

    Clear the controller parameter stack

    By default, clears all parameters. If a parameter name is given, clears only that parameter; if an array of parameter names is provided, clears each.

    Parameters
    Name Type Description
    $name null|string|array

    single key or array of keys for params to clear

    Returns
    Type Description
    \Zend_Controller_Router_Interface
    methodpublicgetFrontController( ) : \Zend_Controller_Front

    Retrieve Front Controller

    Returns
    Type Description
    \Zend_Controller_Front
    methodpublicgetParam( string $name ) : mixed

    Retrieve a single parameter from the controller parameter stack

    Parameters
    Name Type Description
    $name string
    Returns
    Type Description
    mixed
    methodpublicgetParams( ) : array

    Retrieve the parameters to pass to helper object constructors

    Returns
    Type Description
    array
    methodpublicroute(  $dispatcher ) : \Zend_Controller_Request_Abstract|boolean

    Processes a request and sets its controller and action. If no route was possible, an exception is thrown.

    Parameters
    Name Type Description
    $dispatcher

    Zend_Controller_Request_Abstract

    Returns
    Type Description
    \Zend_Controller_Request_Abstract|boolean
    Throws
    Exception Description
    \Zend_Controller_Router_Exception
    methodpublicsetFrontController( \Zend_Controller_Front $controller ) : \Zend_Controller_Router_Interface

    Set Front Controller

    Parameters
    Name Type Description
    $controller \Zend_Controller_Front
    Returns
    Type Description
    \Zend_Controller_Router_Interface
    methodpublicsetParam( string $name,  $value ) : \Zend_Controller_Router_Interface

    Add or modify a parameter with which to instantiate any helper objects

    Parameters
    Name Type Description
    $name string
    $value
    Returns
    Type Description
    \Zend_Controller_Router_Interface
    methodpublicsetParams( array $params ) : \Zend_Controller_Router_Interface

    Set an array of a parameters to pass to helper object constructors

    Parameters
    Name Type Description
    $params array
    Returns
    Type Description
    \Zend_Controller_Router_Interface
    Documentation was generated by DocBlox 0.15.1.