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.
Abstract class representing container for placeholder values

bool
$_captureLock= 'false'
Whether or not we're already capturing for this given container
false
Details
string
$_captureType= ''
What type of capture (overwrite (set), append, prepend) to use

string
$_indent= ''''
What string to use as the indentation of output, this will typically be spaces. Eg: ' '
''
Details
string
$_postfix= ''''
What text to append the placeholder with when rendering
''
Details
string
$_prefix= ''''
What text to prefix the placeholder with when rendering
''
Details
__construct(
)
:
void
Constructor - This is needed so that we can attach a class member as the ArrayObject container

captureStart(
int $type
=
Zend_View_Helper_Placeholder_Container_Abstract::APPEND, $key
=
null
)
:
void
Start capturing content to push into placeholder
Name | Type | Description |
---|---|---|
$type | int | How to capture content into placeholder; append, prepend, or set |
$key |
Exception | Description |
---|---|
\Zend_View_Helper_Placeholder_Exception | if nested captures detected |

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

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

prepend(
mixed $value
)
:
void
Prepend a value to the top of the container
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
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
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
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
Used to implode elements in container
Name | Type | Description |
---|---|---|
$separator | string |
Type | Description |
---|---|
\Zend_View_Helper_Placeholder_Container |