Zend Framework
Back to top  

Container for placeholder values

 Methods

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

__construct() 
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::__construct()

Serialize object to string

__toString() : string
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::__toString()

Returns

string

Append a value to the end of the container

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

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::append()

Parameters

$value

mixed

Returns

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

asort() 

asort() 
Inherited

inherited_from ArrayObject::asort()
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::asort()

End content capture

captureEnd() : void
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::captureEnd()

Start capturing content to push into placeholder

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

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::captureStart()

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

inherited_from ArrayObject::count()
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::count()

exchangeArray() 

exchangeArray() 
Inherited

inherited_from ArrayObject::exchangeArray()
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::exchangeArray()

getArrayCopy() 

getArrayCopy() 
Inherited

inherited_from ArrayObject::getArrayCopy()
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::getArrayCopy()

getFlags() 

getFlags() 
Inherited

inherited_from ArrayObject::getFlags()
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::getFlags()

Retrieve indentation

getIndent() : string
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::getIndent()

Returns

string

getIterator() 

getIterator() 
Inherited

inherited_from ArrayObject::getIterator()
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::getIterator()

getIteratorClass() 

getIteratorClass() 
Inherited

inherited_from ArrayObject::getIteratorClass()
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::getIteratorClass()

Get keys

getKeys() : array
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::getKeys()

Returns

array

Retrieve postfix

getPostfix() : string
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::getPostfix()

Returns

string

Retrieve prefix

getPrefix() : string
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::getPrefix()

Returns

string

Retrieve separator

getSeparator() : string
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::getSeparator()

Returns

string

Retrieve container value

getValue() : mixed
Inherited

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

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::getValue()

Returns

mixed

Retrieve whitespace representation of $indent

getWhitespace(int | string $indent) : string
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::getWhitespace()

Parameters

$indent

intstring

Returns

string

ksort() 

ksort() 
Inherited

inherited_from ArrayObject::ksort()
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::ksort()

natcasesort() 

natcasesort() 
Inherited

inherited_from ArrayObject::natcasesort()
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::natcasesort()

natsort() 

natsort() 
Inherited

inherited_from ArrayObject::natsort()
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::natsort()

Next Index as defined by the PHP manual

nextIndex() : int
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::nextIndex()

Returns

int

offsetExists() 

offsetExists() 
Inherited

inherited_from ArrayObject::offsetExists()
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::offsetExists()

offsetGet() 

offsetGet() 
Inherited

inherited_from ArrayObject::offsetGet()
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::offsetGet()

offsetSet() 

offsetSet() 
Inherited

inherited_from ArrayObject::offsetSet()
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::offsetSet()

offsetUnset() 

offsetUnset() 
Inherited

inherited_from ArrayObject::offsetUnset()
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::offsetUnset()

Prepend a value to the top of the container

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

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::prepend()

Parameters

$value

mixed

Returns

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

serialize() 

serialize() 
Inherited

inherited_from ArrayObject::serialize()
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::serialize()

Set a single value

set(mixed $value) : void
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::set()

Parameters

$value

mixed

setFlags() 

setFlags() 
Inherited

inherited_from ArrayObject::setFlags()
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::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
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::setIndent()

Parameters

$indent

stringint

Returns

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

setIteratorClass() 

setIteratorClass() 
Inherited

inherited_from ArrayObject::setIteratorClass()
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::setIteratorClass()

Set postfix for __toString() serialization

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

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::setPostfix()

Parameters

$postfix

string

Returns

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

Set prefix for __toString() serialization

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

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::setPrefix()

Parameters

$prefix

string

Returns

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

Set separator for __toString() serialization

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

Used to implode elements in container

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::setSeparator()

Parameters

$separator

string

Returns

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

Render the placeholder

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

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::toString()

Parameters

$indent

nullintstring

Returns

string

uasort() 

uasort() 
Inherited

inherited_from ArrayObject::uasort()
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::uasort()

uksort() 

uksort() 
Inherited

inherited_from ArrayObject::uksort()
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::uksort()

unserialize() 

unserialize() 
Inherited

inherited_from ArrayObject::unserialize()
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::unserialize()

 Properties

 

Key to which to capture content

$captureKey : string
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::$$captureKey
 

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

$captureLock : bool
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::$$captureLock
 

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

$captureType : string
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::$$captureType
 

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

$indent : string
Inherited

Eg: ' '

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::$$indent
 

What text to append the placeholder with when rendering

$postfix : string
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::$$postfix
 

What text to prefix the placeholder with when rendering

$prefix : string
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::$$prefix
 

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

$separator : string
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::$$separator

 Constants

 

Whether or not to append contents to placeholder

APPEND 
Inherited

const string
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::APPEND
 

Whether or not to prepend contents to placeholder

PREPEND 
Inherited

const string
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::PREPEND
 

Whether or not to override all contents of placeholder

SET 
Inherited

const string
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractContainer::SET