Controller/Action/HelperBroker/PriorityStack.php

Show: PublicProtectedPrivateinherited
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_Controller  
Subpackage
Zend_Controller_Action  
Version
$Id$  

\Zend_Controller_Action_HelperBroker_PriorityStack

Package: Zend_Controller\Zend_Controller_Action
Implements
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected$_helpersByNameRef = array()
Default valuearray()Details
Type
n/a
>VPropertyprotected$_helpersByPriority = array()
Default valuearray()Details
Type
n/a
>VPropertyprotected$_nextDefaultPriority = 1
Default value1Details
Type
n/a

Methods

methodpublic__get(string $helperName) : \Zend_Controller_Action_Helper_Abstract

Magic property overloading for returning helper by name

Parameters
NameTypeDescription
$helperNamestring

The helper name

Returns
TypeDescription
\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
NameTypeDescription
$helperNamestring

The helper name

Returns
TypeDescription
\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
NameTypeDescription
$helperNamestring

The helper name

Returns
TypeDescription
\Zend_Controller_Action_Helper_Abstract
methodpubliccount() : int

return the count of helpers

Returns
TypeDescription
int
methodpublicgetHelpersByName() : array

return the helpers referenced by name

Returns
TypeDescription
array
methodpublicgetHighestPriority() : int

return the highest priority

Returns
TypeDescription
int
methodpublicgetIterator() : array

Return something iterable

Returns
TypeDescription
array
methodpublicgetLowestPriority() : int

return the lowest priority

Returns
TypeDescription
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
NameTypeDescription
$indexPriorityint

OPTIONAL

Returns
TypeDescription
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
NameTypeDescription
$indexPriorityint
Returns
TypeDescription
int
methodpublicoffsetExists(int | string $priorityOrHelperName) : \Zend_Controller_Action_HelperBroker_PriorityStack

offsetExists()

Parameters
NameTypeDescription
$priorityOrHelperNameint | string
Returns
TypeDescription
\Zend_Controller_Action_HelperBroker_PriorityStack
methodpublicoffsetGet(int | string $priorityOrHelperName) : \Zend_Controller_Action_HelperBroker_PriorityStack

offsetGet()

Parameters
NameTypeDescription
$priorityOrHelperNameint | string
Returns
TypeDescription
\Zend_Controller_Action_HelperBroker_PriorityStack
methodpublicoffsetSet(int $priority, \Zend_Controller_Action_Helper_Abstract $helper) : \Zend_Controller_Action_HelperBroker_PriorityStack

offsetSet()

Parameters
NameTypeDescription
$priorityint
$helper\Zend_Controller_Action_Helper_Abstract
Returns
TypeDescription
\Zend_Controller_Action_HelperBroker_PriorityStack
methodpublicoffsetUnset(int | string $priorityOrHelperName) : \Zend_Controller_Action_HelperBroker_PriorityStack

offsetUnset()

Parameters
NameTypeDescription
$priorityOrHelperNameint | string

Priority integer or the helper name

Returns
TypeDescription
\Zend_Controller_Action_HelperBroker_PriorityStack
Documentation was generated by phpDocumentor 2.2.0 .