Zend Framework  1.12
Public Member Functions | Public Attributes | Protected Attributes | List of all members
Zend_View_Helper_Placeholder_Container_Abstract Class Reference

Public Member Functions

 __construct ()
 Constructor - This is needed so that we can attach a class member as the ArrayObject container.
 
 set ($value)
 Set a single value.
 
 prepend ($value)
 Prepend a value to the top of the container.
 
 getValue ()
 Retrieve container value.
 
 setPrefix ($prefix)
 Set prefix for __toString() serialization.
 
 getPrefix ()
 Retrieve prefix.
 
 setPostfix ($postfix)
 Set postfix for __toString() serialization.
 
 getPostfix ()
 Retrieve postfix.
 
 setSeparator ($separator)
 Set separator for __toString() serialization.
 
 getSeparator ()
 Retrieve separator.
 
 setIndent ($indent)
 Set the indentation string for __toString() serialization, optionally, if a number is passed, it will be the number of spaces.
 
 getIndent ()
 Retrieve indentation.
 
 getWhitespace ($indent)
 Retrieve whitespace representation of $indent.
 
 captureStart ($type=Zend_View_Helper_Placeholder_Container_Abstract::APPEND, $key=null)
 Start capturing content to push into placeholder.
 
 captureEnd ()
 End content capture.
 
 getKeys ()
 Get keys.
 
 nextIndex ()
 Next Index.
 
 toString ($indent=null)
 Render the placeholder.
 
 __toString ()
 Serialize object to string.
 

Public Attributes

const SET = 'SET'
 Whether or not to override all contents of placeholder string.
 
const APPEND = 'APPEND'
 Whether or not to append contents to placeholder string.
 
const PREPEND = 'PREPEND'
 Whether or not to prepend contents to placeholder string.
 

Protected Attributes

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

Constructor & Destructor Documentation

__construct ( )

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

Returns

Member Function Documentation

__toString ( )

Serialize object to string.

Returns
string
captureEnd ( )

End content capture.

Returns
void
captureStart (   $type = Zend_View_Helper_Placeholder_Container_Abstract::APPEND,
  $key = null 
)

Start capturing content to push into placeholder.

Parameters
int | string$typeHow to capture content into placeholder; append, prepend, or set
null$key
Exceptions
Zend_View_Helper_Placeholder_Container_Exception
Returns
void
getIndent ( )

Retrieve indentation.

Returns
string
getKeys ( )

Get keys.

Returns
array
getPostfix ( )

Retrieve postfix.

Returns
string
getPrefix ( )

Retrieve prefix.

Returns
string
getSeparator ( )

Retrieve separator.

Returns
string
getValue ( )

Retrieve container value.

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

Returns
mixed
getWhitespace (   $indent)

Retrieve whitespace representation of $indent.

Parameters
int | string$indent
Returns
string
nextIndex ( )

Next Index.

as defined by the PHP manual

Returns
int
prepend (   $value)

Prepend a value to the top of the container.

Parameters
mixed$value
Returns
void
set (   $value)

Set a single value.

Parameters
mixed$value
Returns
void
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
setPostfix (   $postfix)

Set postfix for __toString() serialization.

Parameters
string$postfix
Returns
Zend_View_Helper_Placeholder_Container
setPrefix (   $prefix)

Set prefix for __toString() serialization.

Parameters
string$prefix
Returns
Zend_View_Helper_Placeholder_Container
setSeparator (   $separator)

Set separator for __toString() serialization.

Used to implode elements in container

Parameters
string$separator
Returns
Zend_View_Helper_Placeholder_Container
toString (   $indent = null)

Render the placeholder.

Parameters
null$indent
Returns
string

Member Data Documentation

$_captureKey
protected
$_captureLock = false
protected
$_captureType
protected
$_indent = ''
protected
$_postfix = ''
protected
$_prefix = ''
protected
$_separator = ''
protected
const APPEND = 'APPEND'

Whether or not to append contents to placeholder string.

const PREPEND = 'PREPEND'

Whether or not to prepend contents to placeholder string.

const SET = 'SET'

Whether or not to override all contents of placeholder string.