Navigation/Page/Mvc.php

Show:

inherited

Classes
- \Zend_Navigation_Page_Mvc

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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Navigation
Subpackage: Page
Version: $Id$

\Zend_Navigation_Page_Mvc
jump to top

Package: Zend_Navigation\Page

Represents a page that is defined using module, controller, action, route name and route params to assemble the href

Container class for Zend_Navigation_Page classes.

Parent(s): \Zend_Navigation_Page < \Zend_Navigation_Container
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

string $_action

Action name to use when assembling URL

Details

Type: string

bool $_active = null

Whether this page should be considered active

Default valuenullDetails

Type: bool

string $_controller

Controller name to use when assembling URL

Details

Type: string

bool $_encodeUrl = true

Whether href should be encoded when assembling URL

Default valuetrueDetails

Type: bool
See

string $_hrefCache

Cached href

The use of this variable minimizes execution time when getHref() is called more than once during the lifetime of a request. If a property is updated, the cache is invalidated.

Details

Type: string

string $_module

Module name to use when assembling URL

Details

Type: string

array $_params = array()

Params to use when assembling URL

Default valuearray()Details

Type: array
See

bool $_resetParams = true

Whether params should be reset when assembling URL

Default valuetrueDetails

Type: bool
See

string $_route

Route name to use when assembling URL

Details

Type: string
See

string $_scheme

Scheme to use when assembling URL

Details

Type: string
See

\Zend_View_Helper_ServerUrl $_schemeHelper = null

static

View helper for assembling URLs with schemes

Default valuenullDetails

Type: \Zend_View_Helper_ServerUrl
See

\Zend_Controller_Action_Helper_Url $_urlHelper = null

static

Action helper for assembling URLs

Default valuenullDetails

Type: \Zend_Controller_Action_Helper_Url
See

Methods

addParams(array $params) : \Zend_Navigation_Page_Mvc

Add multiple parameters (to use when assembling URL) at once

URL options passed to the url action helper for assembling URLs.

Parameters

Name	Type	Description
$params	array	paramters as array ('name' => 'value')

Returns

Type	Description
\Zend_Navigation_Page_Mvc	fluent interface, returns self

Details

See

clearParams() : \Zend_Navigation_Page_Mvc

Clear all parameters (to use when assembling URL)

Returns

Type	Description
\Zend_Navigation_Page_Mvc	fluent interface, returns self

Details

See

getAction() : string | null

Returns action name to use when assembling URL

Returns

Type	Description
string \| null	action name

Details

See

getController() : string | null

Returns controller name to use when assembling URL

Returns

Type	Description
string \| null	controller name or null

Details

See

getEncodeUrl() : bool

Returns whether herf should be encoded when assembling URL

Returns

Type	Description
bool	whether herf should be encoded when assembling URL

Details

See

getHref() : string

Returns href for this page

This method uses {@link Zend_Controller_Action_Helper_Url} to assemble the href based on the page's properties.

Returns

Type	Description
string	page href

getModule() : string | null

Returns module name to use when assembling URL

Returns

Type	Description
string \| null	module name or null

Details

See

getParam(string $name) : mixed

Retrieve a single parameter (to use when assembling URL)

Parameters

Name	Type	Description
$name	string	parameter name

Returns

Type	Description
mixed

Details

See

getParams() : array

Retrieve all parameters (to use when assembling URL)

Returns

Type	Description
array	parameters as array ('name' => 'value')

Details

See

getResetParams() : bool

Returns whether params should be reset when assembling URL

Returns

Type	Description
bool	whether params should be reset when assembling URL

Details

See

getRoute() : string

Returns route name to use when assembling URL

Returns

Type	Description
string	route name

Details

See

getScheme() : string | null

Returns scheme to use when assembling URL

Returns

Type	Description
string \| null	scheme or null

Details

See

isActive(bool $recursive = false) : bool

Returns whether page should be considered active or not

This method will compare the page properties against the request object that is found in the front controller.

Parameters

Name	Type	Description
$recursive	bool	[optional] whether page should be considered `active if any child pages are active. Default is false.`

Returns

Type	Description
bool	whether page should be considered active or not

removeParam(string $name) : bool

Remove parameter (to use when assembling URL)

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
bool

Details

See

setAction(string $action) : \Zend_Navigation_Page_Mvc

Sets action name to use when assembling URL

Parameters

Name	Type	Description
$action	string	action name

Returns

Type	Description
\Zend_Navigation_Page_Mvc	fluent interface, returns self

Throws

Exception	Description
\Zend_Navigation_Exception	if invalid $action is given

Details

See

setController(string | null $controller) : \Zend_Navigation_Page_Mvc

Sets controller name to use when assembling URL

Parameters

Name	Type	Description
$controller	string \| null	controller name

Returns

Type	Description
\Zend_Navigation_Page_Mvc	fluent interface, returns self

Throws

Exception	Description
\Zend_Navigation_Exception	if invalid controller name is given

Details

See

setEncodeUrl( $encodeUrl) : \Zend_Navigation_Page_Mvc

Sets whether href should be encoded when assembling URL

Parameters

Name	Type	Description
$encodeUrl

Returns

Type	Description
\Zend_Navigation_Page_Mvc	fluent interface, returns self

Details

See

setModule(string | null $module) : \Zend_Navigation_Page_Mvc

Sets module name to use when assembling URL

Parameters

Name	Type	Description
$module	string \| null	module name

Returns

Type	Description
\Zend_Navigation_Page_Mvc	fluent interface, returns self

Throws

Exception	Description
\Zend_Navigation_Exception	if invalid module name is given

Details

See

setParam(string $name, mixed $value) : \Zend_Navigation_Page_Mvc

Set parameter (to use when assembling URL)

URL option passed to the url action helper for assembling URLs.

Parameters

Name	Type	Description
$name	string	parameter name
$value	mixed	parameter value

Returns

Type	Description
\Zend_Navigation_Page_Mvc	fluent interface, returns self

Details

See

setParams(array | null $params = null) : \Zend_Navigation_Page_Mvc

Set multiple parameters (to use when assembling URL) at once

URL options passed to the url action helper for assembling URLs. Overwrites any previously set parameters!

Parameters

Name	Type	Description
$params	array \| null	[optional] paramters as array `('name' => 'value'). Default is null which clears all params.`

Returns

Type	Description
\Zend_Navigation_Page_Mvc	fluent interface, returns self

Details

See

setResetParams(bool $resetParams) : \Zend_Navigation_Page_Mvc

Sets whether params should be reset when assembling URL

Parameters

Name	Type	Description
$resetParams	bool	whether params should be reset when assembling URL

Returns

Type	Description
\Zend_Navigation_Page_Mvc	fluent interface, returns self

Details

See

setRoute(string $route) : \Zend_Navigation_Page_Mvc

Sets route name to use when assembling URL

Parameters

Name	Type	Description
$route	string	route name to use when assembling URL

Returns

Type	Description
\Zend_Navigation_Page_Mvc	fluent interface, returns self

Throws

Exception	Description
\Zend_Navigation_Exception	if invalid $route is given

Details

See

setScheme(string | null $scheme) : \Zend_Navigation_Page_Mvc

Sets scheme to use when assembling URL

Parameters

Name	Type	Description
$scheme	string \| null	scheme

Returns

Type	Description
\Zend_Navigation_Page_Mvc	fluent interface, returns self

Throws

Exception	Description
\Zend_Navigation_Exception

Details

See

setSchemeHelper(\Zend_View_Helper_ServerUrl $sh) : void

static

Sets view helper for assembling URLs with schemes

Parameters

Name	Type	Description
$sh	\Zend_View_Helper_ServerUrl	scheme helper

Details

See

setUrlHelper(\Zend_Controller_Action_Helper_Url $uh) : void

static

Sets action helper for assembling URLs

Parameters

Name	Type	Description
$uh	\Zend_Controller_Action_Helper_Url	URL helper

Details

See

toArray() : array

Returns an array representation of the page

Returns

Type	Description
array	associative array containing all page properties

Navigation/Page/Mvc.php

\Zend_Navigation_Page_Mvcjump to top

Properties

Methods

\Zend_Navigation_Page_Mvc
jump to top