Container for placeholder values

package Default
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer

 Methods

Constructor - This is needed so that we can attach a class member as the ArrayObject container

__construct() 
Inherited

Serialize object to string

__toString() : string
Inherited

Returns

string

Append a value to the end of the container

append(mixed $value) : \Zend\View\Helper\Placeholder\Container
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$value

mixed

Returns

\Zend\View\Helper\Placeholder\Container

End content capture

captureEnd() : void
Inherited

Start capturing content to push into placeholder

captureStart(string $type = \Zend\View\Helper\Placeholder\Container\AbstractContainer::APPEND, mixed $key = null) : void
Inherited

Parameters

$type

string

How to capture content into placeholder; append, prepend, or set

$key

mixed

Key to which to capture content

Exceptions

\Zend\View\Exception\RuntimeException if nested captures detected

Retrieve indentation

getIndent() : string
Inherited

Returns

string

Get keys

getKeys() : array
Inherited

Returns

array

Retrieve postfix

getPostfix() : string
Inherited

Returns

string

Retrieve prefix

getPrefix() : string
Inherited

Returns

string

Retrieve separator

getSeparator() : string
Inherited

Returns

string

Retrieve container value

getValue() : mixed
Inherited

If single element registered, returns that element; otherwise, serializes to array.

Returns

mixed

Retrieve whitespace representation of $indent

getWhitespace(integer|string $indent) : string
Inherited

Parameters

$indent

integerstring

Returns

string

Next Index as defined by the PHP manual

nextIndex() : integer
Inherited

Returns

integer

Prepend a value to the top of the container

prepend(mixed $value) : \Zend\View\Helper\Placeholder\Container
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$value

mixed

Returns

\Zend\View\Helper\Placeholder\Container

Set a single value

set(mixed $value) : void
Inherited

Parameters

$value

mixed

Set the indentation string for __toString() serialization, optionally, if a number is passed, it will be the number of spaces

setIndent(string|integer $indent) : \Zend\View\Helper\Placeholder\Container
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$indent

stringinteger

Returns

\Zend\View\Helper\Placeholder\Container

Set postfix for __toString() serialization

setPostfix(string $postfix) : \Zend\View\Helper\Placeholder\Container
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$postfix

string

Returns

\Zend\View\Helper\Placeholder\Container

Set prefix for __toString() serialization

setPrefix(string $prefix) : \Zend\View\Helper\Placeholder\Container
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$prefix

string

Returns

\Zend\View\Helper\Placeholder\Container

Set separator for __toString() serialization

setSeparator(string $separator) : \Zend\View\Helper\Placeholder\Container
Inherited

Used to implode elements in container

fluent This method is part of a fluent interface and will return the same instance

Parameters

$separator

string

Returns

\Zend\View\Helper\Placeholder\Container

Render the placeholder

toString(null|integer|string $indent = null) : string
Inherited

Parameters

$indent

nullintegerstring

Returns

string

 Properties

 

Key to which to capture content

$captureKey : string

Default

 

Whether or not we're already capturing for this given container

$captureLock : boolean

Default

false
 

What type of capture (overwrite (set), append, prepend) to use

$captureType : string

Default

 

What string to use as the indentation of output, this will typically be spaces. Eg: ' '

$indent : string

Default

''
 

What text to append the placeholder with when rendering

$postfix : string

Default

''
 

What text to prefix the placeholder with when rendering

$prefix : string

Default

''
 

What string to use between individual items in the placeholder when rendering

$separator : string

Default

''

 Constants

 

Whether or not to append contents to placeholder

APPEND = 'APPEND' 
const string
 

Whether or not to prepend contents to placeholder

PREPEND = 'PREPEND' 
const string
 

Whether or not to override all contents of placeholder

SET = 'SET' 
const string