API Documentation

Zend/Controller/Action/HelperBroker/PriorityStack.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
Zend_Controller_Action  
Version
$Id: PriorityStack.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Controller_Action_HelperBroker_PriorityStack

Package: Zend\Controller\Zend\Controller\Action

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

Properties

Propertyprotected  $_helpersByNameRef= 'array()'
Default valuearray()Details
Type
Propertyprotected  $_helpersByPriority= 'array()'
Default valuearray()Details
Type
Propertyprotected  $_nextDefaultPriority= '1'
Default value1Details
Type

Methods

methodpublic__get( string $helperName ) : \Zend_Controller_Action_Helper_Abstract

Magic property overloading for returning helper by name

Parameters
Name Type Description
$helperName string

The helper name

Returns
Type Description
\Zend_Controller_Action_Helper_Abstract
methodpublic__isset( string $helperName ) : \Zend_Controller_Action_Helper_Abstract

Magic property overloading for returning if helper is set by name

Parameters
Name Type Description
$helperName string

The helper name

Returns
Type Description
\Zend_Controller_Action_Helper_Abstract
methodpublic__unset( string $helperName ) : \Zend_Controller_Action_Helper_Abstract

Magic property overloading for unsetting if helper is exists by name

Parameters
Name Type Description
$helperName string

The helper name

Returns
Type Description
\Zend_Controller_Action_Helper_Abstract
methodpubliccount( ) : int

return the count of helpers

Returns
Type Description
int
methodpublicgetHelpersByName( ) : array

return the helpers referenced by name

Returns
Type Description
array
methodpublicgetHighestPriority( ) : int

return the highest priority

Returns
Type Description
int
methodpublicgetIterator( ) : array

Return something iterable

Returns
Type Description
array
methodpublicgetLowestPriority( ) : int

return the lowest priority

Returns
Type Description
int
methodpublicgetNextFreeHigherPriority( 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.

Parameters
Name Type Description
$indexPriority int

OPTIONAL

Returns
Type Description
int
methodpublicgetNextFreeLowerPriority( 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.

Parameters
Name Type Description
$indexPriority int
Returns
Type Description
int
methodpublicoffsetExists( int|string $priorityOrHelperName ) : \Zend_Controller_Action_HelperBroker_PriorityStack

offsetExists()

Parameters
Name Type Description
$priorityOrHelperName int|string
Returns
Type Description
\Zend_Controller_Action_HelperBroker_PriorityStack
methodpublicoffsetGet( int|string $priorityOrHelperName ) : \Zend_Controller_Action_HelperBroker_PriorityStack

offsetGet()

Parameters
Name Type Description
$priorityOrHelperName int|string
Returns
Type Description
\Zend_Controller_Action_HelperBroker_PriorityStack
methodpublicoffsetSet( int $priority, \Zend_Controller_Action_Helper_Abstract $helper ) : \Zend_Controller_Action_HelperBroker_PriorityStack

offsetSet()

Parameters
Name Type Description
$priority int
$helper \Zend_Controller_Action_Helper_Abstract
Returns
Type Description
\Zend_Controller_Action_HelperBroker_PriorityStack
methodpublicoffsetUnset( int|string $priorityOrHelperName ) : \Zend_Controller_Action_HelperBroker_PriorityStack

offsetUnset()

Parameters
Name Type Description
$priorityOrHelperName int|string

Priority integer or the helper name

Returns
Type Description
\Zend_Controller_Action_HelperBroker_PriorityStack
Documentation was generated by DocBlox 0.15.1.