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.
Container for placeholder values

__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()
__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 $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()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 |

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

getKeys(
)
:
array
Get keys
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::getKeys()Type | Description |
---|---|
array |

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 |

nextIndex(
)
:
int
Next Index
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::nextIndex()as defined by the PHP manual
Type | Description |
---|---|
int |

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 |

set(
mixed $value
)
:
void
Set a single value
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::set()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(
$indent
=
null
)
:
string
Render the placeholder
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::toString()Name | Type | Description |
---|---|---|
$indent |
Type | Description |
---|---|
string |