API Documentation

Controller/Action/HelperBroker/PriorityStack.php

Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Controller
subpackage
Zend_Controller_Action
version
$Id: PriorityStack.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Controller_Action_HelperBroker_PriorityStack

Description

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.

Zend_Controller_Action_HelperBroker_PriorityStack
jump to top

Implements
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Controller
subpackage
Zend_Controller_Action
Properties
$_helpersByPriority
$_helpersByNameRef
$_nextDefaultPriority
Methods
__get
__isset
__unset
push
getIterator
offsetExists
offsetGet
offsetSet
offsetUnset
count
getNextFreeHigherPriority
getNextFreeLowerPriority
getHighestPriority
getLowestPriority
getHelpersByName

Description

Properties

$_helpersByNameRef
jump to class

 $_helpersByNameRef = 'array'

Details

visibility
protected
default
array
final
false
static
false

$_helpersByPriority
jump to class

 $_helpersByPriority = 'array'

Details

visibility
protected
default
array
final
false
static
false

$_nextDefaultPriority
jump to class

 $_nextDefaultPriority = '1'

Details

visibility
protected
default
1
final
false
static
false

Methods

__get
jump to class

__get( string $helperName ) : Zend_Controller_Action_Helper_Abstract

Magic property overloading for returning helper by name

Arguments
$helperName
string
The helper name
Output
Zend_Controller_Action_Helper_Abstract
Details
visibility
public
final
false
static
false

__isset
jump to class

__isset( string $helperName ) : Zend_Controller_Action_Helper_Abstract

Magic property overloading for returning if helper is set by name

Arguments
$helperName
string
The helper name
Output
Zend_Controller_Action_Helper_Abstract
Details
visibility
public
final
false
static
false

__unset
jump to class

__unset( string $helperName ) : Zend_Controller_Action_Helper_Abstract

Magic property overloading for unsetting if helper is exists by name

Arguments
$helperName
string
The helper name
Output
Zend_Controller_Action_Helper_Abstract
Details
visibility
public
final
false
static
false

count
jump to class

count( ) : int

return the count of helpers

Output
int
Details
visibility
public
final
false
static
false

getHelpersByName
jump to class

getHelpersByName( ) : array

return the helpers referenced by name

Output
array
Details
visibility
public
final
false
static
false

getHighestPriority
jump to class

getHighestPriority( ) : int

return the highest priority

Output
int
Details
visibility
public
final
false
static
false

getIterator
jump to class

getIterator( ) : array

Return something iterable

Output
array
Details
visibility
public
final
false
static
false

getLowestPriority
jump to class

getLowestPriority( ) : int

return the lowest priority

Output
int
Details
visibility
public
final
false
static
false

getNextFreeHigherPriority
jump to class

getNextFreeHigherPriority( int $indexPriority = null ) : int

Find the next free higher priority. If an index is given, it will find the next free highest priority after it.

Arguments
$indexPriority
int
OPTIONAL
Output
int
Details
visibility
public
final
false
static
false

getNextFreeLowerPriority
jump to class

getNextFreeLowerPriority( int $indexPriority = null ) : int

Find the next free lower priority. If an index is given, it will find the next free lower priority before it.

Arguments
$indexPriority
int
Output
int
Details
visibility
public
final
false
static
false

offsetExists
jump to class

offsetExists( int|string $priorityOrHelperName ) : Zend_Controller_Action_HelperBroker_PriorityStack

offsetExists()

Arguments
$priorityOrHelperName
intstring
Output
Zend_Controller_Action_HelperBroker_PriorityStack
Details
visibility
public
final
false
static
false

offsetGet
jump to class

offsetGet( int|string $priorityOrHelperName ) : Zend_Controller_Action_HelperBroker_PriorityStack

offsetGet()

Arguments
$priorityOrHelperName
intstring
Output
Zend_Controller_Action_HelperBroker_PriorityStack
Details
visibility
public
final
false
static
false

offsetSet
jump to class

offsetSet( int $priority, Zend_Controller_Action_Helper_Abstract $helper ) : Zend_Controller_Action_HelperBroker_PriorityStack

offsetSet()

Arguments
$priority
int
$helper
Zend_Controller_Action_Helper_Abstract
Output
Zend_Controller_Action_HelperBroker_PriorityStack
Details
visibility
public
final
false
static
false

offsetUnset
jump to class

offsetUnset( int|string $priorityOrHelperName ) : Zend_Controller_Action_HelperBroker_PriorityStack

offsetUnset()

Arguments
$priorityOrHelperName
intstring
Priority integer or the helper name
Output
Zend_Controller_Action_HelperBroker_PriorityStack
Details
visibility
public
final
false
static
false

push
jump to class

push( Zend_Controller_Action_Helper_Abstract $helper ) : Zend_Controller_Action_HelperBroker_PriorityStack

push helper onto the stack

Arguments
$helper
Zend_Controller_Action_Helper_Abstract
Output
Zend_Controller_Action_HelperBroker_PriorityStack
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.