Zend\View\Helper\Placeholder\Container
Container for placeholder values
Synopsis
class Container
extends AbstractContainer
{
- // Inherited constants from AbstractContainer
- const SET = 'SET';
- const APPEND = 'APPEND';
- const PREPEND = 'PREPEND';
- // Inherited constants from ArrayObject
- const = 1;
- const = 2;
- // Inherited members from AbstractContainer
- protected string $captureKey;
- protected bool $captureLock;
- protected string $captureType;
- protected string $indent;
- protected string $postfix;
- protected string $prefix;
- protected string $separator;
- // Inherited methods from AbstractContainer
- public void __construct()
- public string __toString()
- public string toString()
- public void captureStart()
- public void captureEnd()
- public array getKeys()
- public mixed getValue()
- public string getWhitespace()
- public void set()
- public self prepend()
- public self append()
- public int nextIndex()
- public self setIndent()
- public string getIndent()
- public self setPostfix()
- public string getPostfix()
- public self setPrefix()
- public string getPrefix()
- public self setSeparator()
- public string getSeparator()
- // Inherited methods from ArrayObject
- public void __construct()
- public void append()
- public void asort()
- public int count()
- public array exchangeArray()
- public array getArrayCopy()
- public int getFlags()
- public ArrayIterator getIterator()
- public string getIteratorClass()
- public void ksort()
- public void natcasesort()
- public void natsort()
- public bool offsetExists()
- public mixed offsetGet()
- public void offsetSet()
- public void offsetUnset()
- public void serialize()
- public void setFlags()
- public void setIteratorClass()
- public void uasort()
- public void uksort()
- public void unserialize()
Hierarchy
Constants
Name | Value |
---|---|
SET | 'SET' |
APPEND | 'APPEND' |
PREPEND | 'PREPEND' |
1 | |
2 |
Members
protected
- $captureKey
—
string
Key to which to capture content - $captureLock
—
Zend\View\Helper\Placeholder\Container\bool
Whether or not we're already capturing for this given container - $captureType
—
string
What type of capture (overwrite (set), append, prepend) to use - $indent
—
string
What string to use as the indentation of output, this will typically be spaces. Eg: ' ' - $postfix
—
string
What text to append the placeholder with when rendering - $prefix
—
string
What text to prefix the placeholder with when rendering - $separator
—
string
What string to use between individual items in the placeholder when rendering
Methods
Inherited from Zend\View\Helper\Placeholder\Container\AbstractContainer
public
- __toString() — Serialize object to string
- append() — Append a value to the end of the container
- captureEnd() — End content capture
- captureStart() — Start capturing content to push into placeholder
- getIndent() — Retrieve indentation
- getKeys() — Get keys
- getPostfix() — Retrieve postfix
- getPrefix() — Retrieve prefix
- getSeparator() — Retrieve separator
- getValue() — Retrieve container value
- getWhitespace() — Retrieve whitespace representation of $indent
- nextIndex() — Next Index as defined by the PHP manual
- prepend() — Prepend a value to the top of the container
- set() — Set a single value
- setIndent() — Set the indentation string for __toString() serialization, optionally, if a number is passed, it will be the number of spaces
- setPostfix() — Set postfix for __toString() serialization
- setPrefix() — Set prefix for __toString() serialization
- setSeparator() — Set separator for __toString() serialization
- toString() — Render the placeholder
Inherited from ArrayObject
public
- append() — Appends the value
- asort() — Sort the entries by value
- count() — Get the number of public properties in the ArrayObject
- exchangeArray() — Exchange the array for another one.
- getArrayCopy() — Creates a copy of the ArrayObject.
- getFlags() — Gets the behavior flags.
- getIterator() — Create a new iterator from an ArrayObject instance
- getIteratorClass() — Gets the iterator classname for the ArrayObject.
- ksort() — Sort the entries by key
- natcasesort() — Sort an array using a case insensitive "natural order" algorithm
- natsort() — Sort entries using a "natural order" algorithm
- offsetExists() — Returns whether the requested index exists
- offsetGet() — Returns the value at the specified index
- offsetSet() — Sets the value at the specified index to newval
- offsetUnset() — Unsets the value at the specified index
- serialize() — Serialize an ArrayObject
- setFlags() — Sets the behavior flags.
- setIteratorClass() — Sets the iterator classname for the ArrayObject.
- uasort() — Sort the entries with a user-defined comparison function and maintain key association
- uksort() — Sort the entries by keys using a user-defined comparison function
- unserialize() — Unserialize an ArrayObject