API Documentation

View/Helper/Placeholder/Container.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: Container.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_View_Helper_Placeholder_Container

Container for placeholder values

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

Methods

methodpublic__construct( ) : void

Constructor - This is needed so that we can attach a class member as the ArrayObject container

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::__construct()
methodpublic__toString( ) : string

Serialize object to string

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::__toString()
Returns
Type Description
string
methodpublicappend( ) : void

Inherited from:
methodpublicasort( ) : void

Inherited from:
methodpubliccaptureEnd( ) : void
methodpubliccaptureStart( int $type = Zend_View_Helper_Placeholder_Container_Abstract,  $key = null ) : void

Start capturing content to push into placeholder

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::captureStart()
Parameters
Name Type Description
$type int How to capture content into placeholder; append, prepend, or set
$key
Throws
Exception Description
\Zend_View_Helper_Placeholder_Exception if nested captures detected
methodpubliccount( ) : void

Inherited from:
methodpublicexchangeArray( ) : void

Inherited from:
methodpublicgetArrayCopy( ) : void

Inherited from:
methodpublicgetFlags( ) : void

Inherited from:
methodpublicgetIndent( ) : string
Returns
Type Description
string
methodpublicgetIterator( ) : void

Inherited from:
methodpublicgetIteratorClass( ) : void

Inherited from:
methodpublicgetKeys( ) : array
Returns
Type Description
array
methodpublicgetPostfix( ) : string
Returns
Type Description
string
methodpublicgetPrefix( ) : string
Returns
Type Description
string
methodpublicgetSeparator( ) : string
Returns
Type Description
string
methodpublicgetValue( ) : mixed

Retrieve container value

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::getValue()

If single element registered, returns that element; otherwise, serializes to array.

Returns
Type Description
mixed
methodpublicgetWhitespace( int|string $indent ) : string

Retrieve whitespace representation of $indent

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::getWhitespace()
Parameters
Name Type Description
$indent int|string
Returns
Type Description
string
methodpublicksort( ) : void

Inherited from:
methodpublicnatcasesort( ) : void

Inherited from:
methodpublicnatsort( ) : void

Inherited from:
methodpublicnextIndex( ) : int

as defined by the PHP manual

Returns
Type Description
int
methodpublicoffsetExists( ) : void

Inherited from:
methodpublicoffsetGet( ) : void

Inherited from:
methodpublicoffsetSet( ) : void

Inherited from:
methodpublicoffsetUnset( ) : void

Inherited from:
methodpublicprepend( mixed $value ) : void

Prepend a value to the top of the container

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::prepend()
Parameters
Name Type Description
$value mixed
methodpublicserialize( ) : void

Inherited from:
methodpublicset( mixed $value ) : void

Set a single value

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::set()
Parameters
Name Type Description
$value mixed
methodpublicsetFlags( ) : void

Inherited from:
methodpublicsetIndent( string|int $indent ) : \Zend_View_Helper_Placeholder_Container_Abstract

Set the indentation string for __toString() serialization, optionally, if a number is passed, it will be the number of spaces

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::setIndent()
Parameters
Name Type Description
$indent string|int
Returns
Type Description
\Zend_View_Helper_Placeholder_Container_Abstract
methodpublicsetIteratorClass( ) : void

Inherited from:
methodpublicsetPostfix( string $postfix ) : \Zend_View_Helper_Placeholder_Container

Set postfix for __toString() serialization

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::setPostfix()
Parameters
Name Type Description
$postfix string
Returns
Type Description
\Zend_View_Helper_Placeholder_Container
methodpublicsetPrefix( string $prefix ) : \Zend_View_Helper_Placeholder_Container

Set prefix for __toString() serialization

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::setPrefix()
Parameters
Name Type Description
$prefix string
Returns
Type Description
\Zend_View_Helper_Placeholder_Container
methodpublicsetSeparator( string $separator ) : \Zend_View_Helper_Placeholder_Container

Set separator for __toString() serialization

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::setSeparator()

Used to implode elements in container

Parameters
Name Type Description
$separator string
Returns
Type Description
\Zend_View_Helper_Placeholder_Container
methodpublictoString(  $indent = null ) : string

Render the placeholder

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::toString()
Parameters
Name Type Description
$indent
Returns
Type Description
string
methodpublicuasort( ) : void

Inherited from:
methodpublicuksort( ) : void

Inherited from:
methodpublicunserialize( ) : void

Inherited from:
Documentation was generated by DocBlox 0.13.3.