API Documentation

View/Helper/Placeholder/Registry.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_View  
subpackage
Helper  
version
$Id: Registry.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_View_Helper_Placeholder_Registry

Registry for placeholder containers

copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_View  
subpackage
Helper  

Constants

Constant  REGISTRY_KEY = 'Zend_View_Helper_Placeholder_Registry'

Zend_Registry key under which placeholder registry exists

const
string  

Properties

Propertyprotectedstring  $_containerClass= 'Zend_View_Helper_Placeholder_Container'

Default container class

Default valueZend_View_Helper_Placeholder_ContainerDetails
Type
string
Propertyprotectedarray  $_items= 'array'

Placeholder containers

Default valuearrayDetails
Type
array

Methods

methodpubliccontainerExists( string $key ) : bool

Does a particular container exist?

Parameters
Name Type Description
$key string
Returns
Type Description
bool
methodpubliccreateContainer( string $key, array $value = array ) : \Zend_View_Helper_Placeholder_Container_Abstract

createContainer

Parameters
Name Type Description
$key string
$value array
Returns
Type Description
\Zend_View_Helper_Placeholder_Container_Abstract
methodpublicdeleteContainer( string $key ) : bool

Delete a container

Parameters
Name Type Description
$key string
Returns
Type Description
bool
methodpublicgetContainer( string $key ) : \Zend_View_Helper_Placeholder_Container_Abstract

Retrieve a placeholder container

Parameters
Name Type Description
$key string
Returns
Type Description
\Zend_View_Helper_Placeholder_Container_Abstract
methodpublicgetContainerClass( ) : string

Retrieve the container class

Returns
Type Description
string
methodpublicgetRegistry( ) : void
static

Retrieve or create registry instnace

methodpublicsetContainer( string $key, \Zend_View_Placeholder_Container_Abstract $container ) : \Zend_View_Placeholder_Registry

Set the container for an item in the registry

Parameters
Name Type Description
$key string
$container \Zend_View_Placeholder_Container_Abstract
Returns
Type Description
\Zend_View_Placeholder_Registry
methodpublicsetContainerClass( string $name ) : \Zend_View_Helper_Placeholder_Registry

Set the container class to use

Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_View_Helper_Placeholder_Registry
Documentation was generated by DocBlox 0.13.3.