Docs For Class Zend_View_Helper_Placeholder_Container

Description

Abstract class representing container for placeholder values

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
abstract:
license: New BSD License

Located in /View/Helper/Placeholder/Container/Abstract.php (line 31)

ArrayObject
   |
   --Zend_View_Helper_Placeholder_Container_Abstract

Direct descendents

Class	Description
Zend_View_Helper_Placeholder_Container	Container for placeholder values

Class Constant Summary

APPEND = 'APPEND'

PREPEND = 'PREPEND'

SET = 'SET'

Variable Summary

string $_captureKey

bool $_captureLock

string $_captureType

string $_indent

string $_postfix

string $_prefix

string $_separator

Method Summary

void captureEnd ()

void captureStart ([int $type = Zend_View_Helper_Placeholder_Container_Abstract::APPEND], [ $key = null])

string getIndent ()

array getKeys ()

string getPostfix ()

string getPrefix ()

string getSeparator ()

mixed getValue ()

string getWhitespace (int|string $indent)

int nextIndex ()

void __construct ()

void prepend (mixed $value)

void set (mixed $value)

Zend_View_Helper_Placeholder_Container_Abstract setIndent (string|int $indent)

Zend_View_Helper_Placeholder_Container setPostfix (string $postfix)

Zend_View_Helper_Placeholder_Container setPrefix (string $prefix)

Zend_View_Helper_Placeholder_Container setSeparator (string $separator)

string toString ([ $indent = null])

string __toString ()

Variables

string $_captureKey (line 91)

Key to which to capture content

access: protected

bool $_captureLock = false (line 79)

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

access: protected

string $_captureType (line 85)

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

access: protected

string $_indent = '' (line 73)

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

access: protected

string $_postfix = '' (line 61)

What text to append the placeholder with when rendering

access: protected

string $_prefix = '' (line 55)

What text to prefix the placeholder with when rendering

access: protected

string $_separator = '' (line 67)

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

access: protected

Methods

captureEnd (line 281)

End content capture

access: public

void captureEnd ()

captureStart (line 259)

Start capturing content to push into placeholder

throws: Zend_View_Helper_Placeholder_Exception if nested captures detected
access: public

void captureStart ([int $type = Zend_View_Helper_Placeholder_Container_Abstract::APPEND], [ $key = null])

int $type: How to capture content into placeholder; append, prepend, or set
$key

getIndent (line 232)

Retrieve indentation

access: public

string getIndent ()

getKeys (line 327)

Get keys

access: public

array getKeys ()

getPostfix (line 185)

Retrieve postfix

access: public

string getPostfix ()

getPrefix (line 163)

Retrieve prefix

access: public

string getPrefix ()

getSeparator (line 209)

Retrieve separator

access: public

string getSeparator ()

getValue (line 135)

Retrieve container value

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

access: public

mixed getValue ()

getWhitespace (line 243)

Retrieve whitespace representation of $indent

access: public

string getWhitespace (int|string $indent)

int|string $indent

nextIndex (line 339)

Next Index

as defined by the PHP manual

access: public

int nextIndex ()

Constructor __construct (line 98)

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

access: public

void __construct ()

Redefinition of:

ArrayObject::constructor __construct ( $array )

prepend (line 120)

Prepend a value to the top of the container

access: public

void prepend (mixed $value)

mixed $value

set (line 109)

Set a single value

access: public

void set (mixed $value)

mixed $value

setIndent (line 221)

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

access: public

Zend_View_Helper_Placeholder_Container_Abstract setIndent (string|int $indent)

string|int $indent

setPostfix (line 174)

Set postfix for __toString() serialization

access: public

Zend_View_Helper_Placeholder_Container setPostfix (string $postfix)

string $postfix

setPrefix (line 152)

Set prefix for __toString() serialization

access: public

Zend_View_Helper_Placeholder_Container setPrefix (string $prefix)

string $prefix

setSeparator (line 198)

Set separator for __toString() serialization

Used to implode elements in container

access: public

Zend_View_Helper_Placeholder_Container setSeparator (string $separator)

string $separator

toString (line 354)

Render the placeholder

access: public

string toString ([ $indent = null])

$indent

__toString (line 374)

Serialize object to string

access: public

string __toString ()

Inherited Methods

Inherited From ArrayObject (Internal Class)

constructor __construct ( $array )
append ( $value )
asort ( )
count ( )
exchangeArray ( $array )
getArrayCopy ( )
getFlags ( )
getIterator ( )
getIteratorClass ( )
ksort ( )
natcasesort ( )
natsort ( )
offsetExists ( $index )
offsetGet ( $index )
offsetSet ( $index, $newval )
offsetUnset ( $index )
setFlags ( $flags )
setIteratorClass ( $iteratorClass )
uasort ( $cmp_function )
uksort ( $cmp_function )

Class Constants

APPEND = 'APPEND' (line 43)

Whether or not to append contents to placeholder

PREPEND = 'PREPEND' (line 49)

Whether or not to prepend contents to placeholder

SET = 'SET' (line 37)

Whether or not to override all contents of placeholder

Inherited Constants

Inherited from ArrayObject (Internal Class)

ARRAY_AS_PROPS = 2
STD_PROP_LIST = 1