Public Member Functions | Data Fields | Protected Attributes

Zend_View_Helper_Placeholder_Container_Abstract Class Reference

Inheritance diagram for Zend_View_Helper_Placeholder_Container_Abstract:
Zend_View_Helper_Placeholder_Container

Public Member Functions

 __construct ()
 set ($value)
 prepend ($value)
 getValue ()
 setPrefix ($prefix)
 getPrefix ()
 setPostfix ($postfix)
 getPostfix ()
 setSeparator ($separator)
 getSeparator ()
 setIndent ($indent)
 getIndent ()
 getWhitespace ($indent)
 captureStart ($type=Zend_View_Helper_Placeholder_Container_Abstract::APPEND, $key=null)
 captureEnd ()
 getKeys ()
 nextIndex ()
 toString ($indent=null)
 __toString ()

Data Fields

const SET = 'SET'
const APPEND = 'APPEND'
const PREPEND = 'PREPEND'

Protected Attributes

 $_prefix = ''
 $_postfix = ''
 $_separator = ''
 $_indent = ''
 $_captureLock = false
 $_captureType
 $_captureKey

Detailed Description

Definition at line 31 of file Abstract.php.


Constructor & Destructor Documentation

__construct (  )

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

Returns:
void

Definition at line 98 of file Abstract.php.


Member Function Documentation

__toString (  )

Serialize object to string

Returns:
string

Definition at line 372 of file Abstract.php.

captureEnd (  )

End content capture

Returns:
void

Definition at line 279 of file Abstract.php.

captureStart ( type = Zend_View_Helper_Placeholder_Container_Abstract::APPEND,
key = null 
)

Start capturing content to push into placeholder

Parameters:
int$typeHow to capture content into placeholder; append, prepend, or set
Returns:
void
Exceptions:
Zend_View_Helper_Placeholder_Exceptionif nested captures detected

Definition at line 259 of file Abstract.php.

getIndent (  )

Retrieve indentation

Returns:
string

Definition at line 232 of file Abstract.php.

getKeys (  )

Get keys

Returns:
array

Definition at line 325 of file Abstract.php.

getPostfix (  )

Retrieve postfix

Returns:
string

Definition at line 185 of file Abstract.php.

getPrefix (  )

Retrieve prefix

Returns:
string

Definition at line 163 of file Abstract.php.

getSeparator (  )

Retrieve separator

Returns:
string

Definition at line 209 of file Abstract.php.

getValue (  )

Retrieve container value

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

Returns:
mixed

Definition at line 135 of file Abstract.php.

getWhitespace ( indent )

Retrieve whitespace representation of $indent

Parameters:
int | string$indent
Returns:
string

Definition at line 243 of file Abstract.php.

nextIndex (  )

Next Index

as defined by the PHP manual

Returns:
int

Definition at line 337 of file Abstract.php.

prepend ( value )

Prepend a value to the top of the container

Parameters:
mixed$value
Returns:
void

Definition at line 120 of file Abstract.php.

set ( value )

Set a single value

Parameters:
mixed$value
Returns:
void

Definition at line 109 of file Abstract.php.

setIndent ( indent )

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

Parameters:
string | int$indent
Returns:
Zend_View_Helper_Placeholder_Container_Abstract

Definition at line 221 of file Abstract.php.

setPostfix ( postfix )

Set postfix for __toString() serialization

Parameters:
string$postfix
Returns:
Zend_View_Helper_Placeholder_Container

Definition at line 174 of file Abstract.php.

setPrefix ( prefix )

Set prefix for __toString() serialization

Parameters:
string$prefix
Returns:
Zend_View_Helper_Placeholder_Container

Definition at line 152 of file Abstract.php.

setSeparator ( separator )

Set separator for __toString() serialization

Used to implode elements in container

Parameters:
string$separator
Returns:
Zend_View_Helper_Placeholder_Container

Definition at line 198 of file Abstract.php.

toString ( indent = null )

Render the placeholder

Returns:
string

Definition at line 352 of file Abstract.php.


Field Documentation

const APPEND = 'APPEND'

Whether or not to append contents to placeholder string

Definition at line 43 of file Abstract.php.

const PREPEND = 'PREPEND'

Whether or not to prepend contents to placeholder string

Definition at line 49 of file Abstract.php.

const SET = 'SET'

Whether or not to override all contents of placeholder string

Definition at line 37 of file Abstract.php.


The documentation for this class was generated from the following file: