Fully Qualified Name: | Zend\View\Helper\Placeholder\Container |
Extends: | AbstractContainer |
Container for placeholder values
Name | Description | Defined By |
---|---|---|
__construct() | Constructor - This is needed so that we can attach a class member as the ArrayObject container | AbstractContainer |
__toString() | Serialize object to string | AbstractContainer |
append() | Append a value to the end of the container | AbstractContainer |
captureEnd() | End content capture | AbstractContainer |
captureStart() | Start capturing content to push into placeholder | AbstractContainer |
getIndent() | Retrieve indentation | AbstractContainer |
getKeys() | Get keys | AbstractContainer |
getPostfix() | Retrieve postfix | AbstractContainer |
getPrefix() | Retrieve prefix | AbstractContainer |
getSeparator() | Retrieve separator | AbstractContainer |
getValue() | Retrieve container value | AbstractContainer |
getWhitespace() | Retrieve whitespace representation of $indent | AbstractContainer |
nextIndex() | Next Index as defined by the PHP manual | AbstractContainer |
prepend() | Prepend a value to the top of the container | AbstractContainer |
set() | Set a single value | AbstractContainer |
setIndent() | Set the indentation string for __toString() serialization, optionally, if a number is passed, it will be the number of spaces | AbstractContainer |
setPostfix() | Set postfix for __toString() serialization | AbstractContainer |
setPrefix() | Set prefix for __toString() serialization | AbstractContainer |
setSeparator() | Set separator for __toString() serialization | AbstractContainer |
toString() | Render the placeholder | AbstractContainer |
Constructor - This is needed so that we can attach a class member as the ArrayObject container
Returns:
Serialize object to string
Returns: string
Append a value to the end of the container
Parameter Name | Type | Description |
---|---|---|
$value | mixed |
Returns: self
End content capture
Returns: void
Start capturing content to push into placeholder
Parameter Name | Type | Description |
---|---|---|
$type | string | How |
$key | mixed | Key |
Returns: void
Retrieve indentation
Returns: string
Get keys
Returns: array
Retrieve postfix
Returns: string
Retrieve prefix
Returns: string
Retrieve separator
Returns: string
Retrieve container value
If single element registered, returns that element; otherwise, serializes to array.
Returns: mixed
Retrieve whitespace representation of $indent
Parameter Name | Type | Description |
---|---|---|
$indent | int|string |
Returns: string
Next Index as defined by the PHP manual
Returns: int
Prepend a value to the top of the container
Parameter Name | Type | Description |
---|---|---|
$value | mixed |
Returns: self
Set a single value
Parameter Name | Type | Description |
---|---|---|
$value | mixed |
Returns: void
Set the indentation string for __toString() serialization, optionally, if a number is passed, it will be the number of spaces
Parameter Name | Type | Description |
---|---|---|
$indent | string|int |
Returns: self
Set postfix for __toString() serialization
Parameter Name | Type | Description |
---|---|---|
$postfix | string |
Returns: self
Set prefix for __toString() serialization
Parameter Name | Type | Description |
---|---|---|
$prefix | string |
Returns: self
Set separator for __toString() serialization
Used to implode elements in container
Parameter Name | Type | Description |
---|---|---|
$separator | string |
Returns: self
Render the placeholder
Parameter Name | Type | Description |
---|---|---|
$indent | null|int|string |
Returns: string