Abstract Class Zend_View_Helper_Placeholder_Container_Abstract

Description

Abstract class representing container for placeholder values

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

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

ArrayObject
   |
   --Zend_View_Helper_Placeholder_Container_Abstract
Direct descendents
Class Description
 class Zend_View_Helper_Placeholder_Container Container for placeholder values
Class Constant Summary
 APPEND = 'APPEND'
 PREPEND = 'PREPEND'
 SET = 'SET'
Variable Summary
 string $_captureKey
 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)
 string toString ([ $indent = null])
 string __toString ()
Variables
string $_captureKey (line 90)

Key to which to capture content

  • access: protected
bool $_captureLock = false (line 78)

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

  • access: protected
string $_captureType (line 84)

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

  • access: protected
string $_indent = '' (line 72)

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

  • access: protected
string $_postfix = '' (line 60)

What text to append the placeholder with when rendering

  • access: protected
string $_prefix = '' (line 54)

What text to prefix the placeholder with when rendering

  • access: protected
string $_separator = '' (line 66)

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

  • access: protected
Methods
captureEnd (line 278)

End content capture

  • access: public
void captureEnd ()
captureStart (line 258)

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 231)

Retrieve indentation

  • access: public
string getIndent ()
getKeys (line 324)

Get keys

  • access: public
array getKeys ()
getPostfix (line 184)

Retrieve postfix

  • access: public
string getPostfix ()
getPrefix (line 162)

Retrieve prefix

  • access: public
string getPrefix ()
getSeparator (line 208)

Retrieve separator

  • access: public
string getSeparator ()
getValue (line 134)

Retrieve container value

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

  • access: public
mixed getValue ()
getWhitespace (line 242)

Retrieve whitespace representation of $indent

  • access: public
string getWhitespace (int|string $indent)
  • int|string $indent
nextIndex (line 336)

Next Index

as defined by the PHP manual

  • access: public
int nextIndex ()
Constructor __construct (line 97)

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 119)

Prepend a value to the top of the container

  • access: public
void prepend (mixed $value)
  • mixed $value
set (line 108)

Set a single value

  • access: public
void set (mixed $value)
  • mixed $value
setIndent (line 220)

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 173)

Set postfix for __toString() serialization

  • access: public
Zend_View_Helper_Placeholder_Container setPostfix (string $postfix)
  • string $postfix
setPrefix (line 151)

Set prefix for __toString() serialization

  • access: public
Zend_View_Helper_Placeholder_Container setPrefix (string $prefix)
  • string $prefix
setSeparator (line 197)

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 351)

Render the placeholder

  • access: public
string toString ([ $indent = null])
  • $indent
__toString (line 371)

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 42)

Whether or not to append contents to placeholder

PREPEND = 'PREPEND' (line 48)

Whether or not to prepend contents to placeholder

SET = 'SET' (line 36)

Whether or not to override all contents of placeholder

Inherited Constants

Inherited from ArrayObject (Internal Class)

ARRAY_AS_PROPS = 2
STD_PROP_LIST = 1

Documentation generated on Fri, 08 Jan 2010 16:03:57 -0500 by phpDocumentor 1.4.3