View/Helper/Placeholder/Container.php
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_View
- Subpackage
- Helper
- Version
- $Id: Container.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_View_Helper_Placeholder_Container
- Parent(s)
- \Zend_View_Helper_Placeholder_Container_Abstract < \ArrayObject
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants

SET
= 'SET'
- Const
- string
- Inherited_from
- \Zend_View_Helper_Placeholder_Container_Abstract::SET

APPEND
= 'APPEND'
- Const
- string
- Inherited_from
- \Zend_View_Helper_Placeholder_Container_Abstract::APPEND

PREPEND
= 'PREPEND'
- Const
- string
- Inherited_from
- \Zend_View_Helper_Placeholder_Container_Abstract::PREPEND
Properties


string $_captureKey
- Type
- string
- Inherited_from
- \Zend_View_Helper_Placeholder_Container_Abstract::$$_captureKey


bool $_captureLock = false
false
Details- Type
- bool
- Inherited_from
- \Zend_View_Helper_Placeholder_Container_Abstract::$$_captureLock


string $_captureType
- Type
- string
- Inherited_from
- \Zend_View_Helper_Placeholder_Container_Abstract::$$_captureType


string $_indent = ''
Eg: ' '
''
Details- Type
- string
- Inherited_from
- \Zend_View_Helper_Placeholder_Container_Abstract::$$_indent


string $_postfix = ''
''
Details- Type
- string
- Inherited_from
- \Zend_View_Helper_Placeholder_Container_Abstract::$$_postfix


string $_prefix = ''
''
Details- Type
- string
- Inherited_from
- \Zend_View_Helper_Placeholder_Container_Abstract::$$_prefix


string $_separator = ''
''
Details- Type
- string
- Inherited_from
- \Zend_View_Helper_Placeholder_Container_Abstract::$$_separator
Methods


__construct() : \Zend_View_Helper_Placeholder_Container_Abstract
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()Type | Description |
---|---|
\Zend_View_Helper_Placeholder_Container_Abstract |


__toString() : string
Serialize object to string
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::__toString()Type | Description |
---|---|
string |


captureEnd() : void
End content capture
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::captureEnd()

captureStart(int | string $type = \Zend_View_Helper_Placeholder_Container_Abstract::APPEND, null $key = null) : void
Start capturing content to push into placeholder
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::captureStart()Name | Type | Description |
---|---|---|
$type | int | string | How to capture content into placeholder; append, prepend, or set |
$key | null |
Exception | Description |
---|---|
\Zend_View_Helper_Placeholder_Container_Exception |


getIndent() : string
Retrieve indentation
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::getIndent()Type | Description |
---|---|
string |


getPostfix() : string
Retrieve postfix
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::getPostfix()Type | Description |
---|---|
string |


getPrefix() : string
Retrieve prefix
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::getPrefix()Type | Description |
---|---|
string |


getSeparator() : string
Retrieve separator
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::getSeparator()Type | Description |
---|---|
string |


getValue() : mixed
Retrieve container value
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::getValue()If single element registered, returns that element; otherwise, serializes to array.
Type | Description |
---|---|
mixed |


getWhitespace(int | string $indent) : string
Retrieve whitespace representation of $indent
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::getWhitespace()Name | Type | Description |
---|---|---|
$indent | int | string |
Type | Description |
---|---|
string |


prepend(mixed $value) : void
Prepend a value to the top of the container
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::prepend()Name | Type | Description |
---|---|---|
$value | mixed |


setIndent(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()Name | Type | Description |
---|---|---|
$indent | string | int |
Type | Description |
---|---|
\Zend_View_Helper_Placeholder_Container_Abstract |


setPostfix(string $postfix) : \Zend_View_Helper_Placeholder_Container
Set postfix for __toString() serialization
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::setPostfix()Name | Type | Description |
---|---|---|
$postfix | string |
Type | Description |
---|---|
\Zend_View_Helper_Placeholder_Container |


setPrefix(string $prefix) : \Zend_View_Helper_Placeholder_Container
Set prefix for __toString() serialization
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::setPrefix()Name | Type | Description |
---|---|---|
$prefix | string |
Type | Description |
---|---|
\Zend_View_Helper_Placeholder_Container |


setSeparator(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
Name | Type | Description |
---|---|---|
$separator | string |
Type | Description |
---|---|
\Zend_View_Helper_Placeholder_Container |


toString(null $indent = null) : string
Render the placeholder
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::toString()Name | Type | Description |
---|---|---|
$indent | null |
Type | Description |
---|---|
string |