Zend Framework
Back to top  

Abstract class representing container for placeholder values

 Methods

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

__construct() 

Serialize object to string

__toString() : string

Returns

string

Append a value to the end of the container

append(mixed $value) : \Zend\View\Helper\Placeholder\Container\self

Parameters

$value

mixed

Returns

\Zend\View\Helper\Placeholder\Container\self

asort() 

asort() 

inherited_from ArrayObject::asort()

End content capture

captureEnd() : void

Start capturing content to push into placeholder

captureStart(string $type, mixed $key) : void

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

count() 

count() 

inherited_from ArrayObject::count()

exchangeArray() 

exchangeArray() 

inherited_from ArrayObject::exchangeArray()

getArrayCopy() 

getArrayCopy() 

inherited_from ArrayObject::getArrayCopy()

getFlags() 

getFlags() 

inherited_from ArrayObject::getFlags()

Retrieve indentation

getIndent() : string

Returns

string

getIterator() 

getIterator() 

inherited_from ArrayObject::getIterator()

getIteratorClass() 

getIteratorClass() 

inherited_from ArrayObject::getIteratorClass()

Get keys

getKeys() : array

Returns

array

Retrieve postfix

getPostfix() : string

Returns

string

Retrieve prefix

getPrefix() : string

Returns

string

Retrieve separator

getSeparator() : string

Returns

string

Retrieve container value

getValue() : mixed

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

Returns

mixed

Retrieve whitespace representation of $indent

getWhitespace(int | string $indent) : string

Parameters

$indent

intstring

Returns

string

ksort() 

ksort() 

inherited_from ArrayObject::ksort()

natcasesort() 

natcasesort() 

inherited_from ArrayObject::natcasesort()

natsort() 

natsort() 

inherited_from ArrayObject::natsort()

Next Index as defined by the PHP manual

nextIndex() : int

Returns

int

offsetExists() 

offsetExists() 

inherited_from ArrayObject::offsetExists()

offsetGet() 

offsetGet() 

inherited_from ArrayObject::offsetGet()

offsetSet() 

offsetSet() 

inherited_from ArrayObject::offsetSet()

offsetUnset() 

offsetUnset() 

inherited_from ArrayObject::offsetUnset()

Prepend a value to the top of the container

prepend(mixed $value) : \Zend\View\Helper\Placeholder\Container\self

Parameters

$value

mixed

Returns

\Zend\View\Helper\Placeholder\Container\self

serialize() 

serialize() 

inherited_from ArrayObject::serialize()

Set a single value

set(mixed $value) : void

Parameters

$value

mixed

setFlags() 

setFlags() 

inherited_from ArrayObject::setFlags()

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

setIndent(string | int $indent) : \Zend\View\Helper\Placeholder\Container\self

Parameters

$indent

stringint

Returns

\Zend\View\Helper\Placeholder\Container\self

setIteratorClass() 

setIteratorClass() 

inherited_from ArrayObject::setIteratorClass()

Set postfix for __toString() serialization

setPostfix(string $postfix) : \Zend\View\Helper\Placeholder\Container\self

Parameters

$postfix

string

Returns

\Zend\View\Helper\Placeholder\Container\self

Set prefix for __toString() serialization

setPrefix(string $prefix) : \Zend\View\Helper\Placeholder\Container\self

Parameters

$prefix

string

Returns

\Zend\View\Helper\Placeholder\Container\self

Set separator for __toString() serialization

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

Used to implode elements in container

Parameters

$separator

string

Returns

\Zend\View\Helper\Placeholder\Container\self

Render the placeholder

toString(null | int | string $indent) : string

Parameters

$indent

nullintstring

Returns

string

uasort() 

uasort() 

inherited_from ArrayObject::uasort()

uksort() 

uksort() 

inherited_from ArrayObject::uksort()

unserialize() 

unserialize() 

inherited_from ArrayObject::unserialize()

 Properties

 

Key to which to capture content

$captureKey : string

 

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

$captureLock : bool

 

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

$captureType : string

 

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

$indent : string

Eg: ' '

 

What text to append the placeholder with when rendering

$postfix : string

 

What text to prefix the placeholder with when rendering

$prefix : string

 

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

$separator : string

 Constants

 

Whether or not to append contents to placeholder

APPEND 

const string
 

Whether or not to prepend contents to placeholder

PREPEND 

const string
 

Whether or not to override all contents of placeholder

SET 

const string