View/Helper/Placeholder/Container/Abstract.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_View
subpackage: Helper
version: $Id: Abstract.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_View_Helper_Placeholder_Container_Abstract

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_View_Helper_Placeholder_Container_Abstract
jump to top

Extends from: ArrayObject
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_View
subpackage: Helper
Constants: SET; APPEND; PREPEND
Properties: $_prefix; $_postfix; $_separator; $_indent; $_captureLock; $_captureType; $_captureKey
Methods: __construct; set; prepend; getValue; setPrefix; getPrefix; setPostfix; getPostfix; setSeparator; getSeparator; setIndent; getIndent; getWhitespace; captureStart; captureEnd; getKeys; nextIndex; toString; __toString

Description

Abstract class representing container for placeholder values

Constants

SET
jump to class

 SET = 'SET'

Whether or not to override all contents of placeholder

Details

value: SET
const: string

APPEND
jump to class

 APPEND = 'APPEND'

Whether or not to append contents to placeholder

Details

value: APPEND
const: string

PREPEND
jump to class

 PREPEND = 'PREPEND'

Whether or not to prepend contents to placeholder

Details

value: PREPEND
const: string

Properties

$_captureKey
jump to class

string $_captureKey = ''

Key to which to capture content

Details

$_captureKey: string
visibility: protected
default
final: false
static: false

$_captureLock
jump to class

bool $_captureLock = 'false'

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

Details

$_captureLock: bool
visibility: protected
default: false
final: false
static: false

$_captureType
jump to class

string $_captureType = ''

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

Details

$_captureType: string
visibility: protected
default
final: false
static: false

$_indent
jump to class

string $_indent = ''

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

Details

$_indent: string
visibility: protected
default
final: false
static: false

$_postfix
jump to class

string $_postfix = ''

What text to append the placeholder with when rendering

Details

$_postfix: string
visibility: protected
default
final: false
static: false

$_prefix
jump to class

string $_prefix = ''

What text to prefix the placeholder with when rendering

Details

$_prefix: string
visibility: protected
default
final: false
static: false

$_separator
jump to class

string $_separator = ''

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

Details

$_separator: string
visibility: protected
default
final: false
static: false

Methods

__construct
jump to class

__construct(
          
          )
        
        :
        void

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

Details

visibility: public
final: false
static: false

__toString
jump to class

__toString(
          
          )
        
        :
        string

Serialize object to string

Output

string

Details

visibility: public
final: false
static: false

captureEnd
jump to class

captureEnd(
          
          )
        
        :
        void

End content capture

Details

visibility: public
final: false
static: false

captureStart
jump to class

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

Start capturing content to push into placeholder

Arguments

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

Details

visibility: public
final: false
static: false
throws: if nested captures detected

getIndent
jump to class

getIndent(
          
          )
        
        :
        string

Retrieve indentation

Output

string

Details

visibility: public
final: false
static: false

getKeys
jump to class

getKeys(
          
          )
        
        :
        array

Get keys

Output

array

Details

visibility: public
final: false
static: false

getPostfix
jump to class

getPostfix(
          
          )
        
        :
        string

Retrieve postfix

Output

string

Details

visibility: public
final: false
static: false

getPrefix
jump to class

getPrefix(
          
          )
        
        :
        string

Retrieve prefix

Output

string

Details

visibility: public
final: false
static: false

getSeparator
jump to class

getSeparator(
          
          )
        
        :
        string

Retrieve separator

Output

string

Details

visibility: public
final: false
static: false

getValue
jump to class

getValue(
          
          )
        
        :
        mixed

Retrieve container value

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

Output

mixed

Details

visibility: public
final: false
static: false

getWhitespace
jump to class

getWhitespace(
          int|string $indent
          )
        
        :
        string

Retrieve whitespace representation of $indent

Arguments

$indent: intstring

Output

string

Details

visibility: public
final: false
static: false

nextIndex
jump to class

nextIndex(
          
          )
        
        :
        int

Next Index

as defined by the PHP manual

Output

int

Details

visibility: public
final: false
static: false

prepend
jump to class

prepend(
          mixed $value
          )
        
        :
        void

Prepend a value to the top of the container

Arguments

$value: mixed

Details

visibility: public
final: false
static: false

set
jump to class

set(
          mixed $value
          )
        
        :
        void

Set a single value

Arguments

$value: mixed

Details

visibility: public
final: false
static: false

setIndent
jump to class

setIndent(
          string|int $indent
          )
        
        :
        Zend_View_Helper_Placeholder_Container_Abstract

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

Arguments

$indent: stringint

Output

Zend_View_Helper_Placeholder_Container_Abstract

Details

visibility: public
final: false
static: false

setPostfix
jump to class

setPostfix(
          string $postfix
          )
        
        :
        Zend_View_Helper_Placeholder_Container

Set postfix for __toString() serialization

Arguments

$postfix: string

Output

Zend_View_Helper_Placeholder_Container

Details

visibility: public
final: false
static: false

setPrefix
jump to class

setPrefix(
          string $prefix
          )
        
        :
        Zend_View_Helper_Placeholder_Container

Set prefix for __toString() serialization

Arguments

$prefix: string

Output

Zend_View_Helper_Placeholder_Container

Details

visibility: public
final: false
static: false

setSeparator
jump to class

setSeparator(
          string $separator
          )
        
        :
        Zend_View_Helper_Placeholder_Container

Set separator for __toString() serialization

Used to implode elements in container

Arguments

$separator: string

Output

Zend_View_Helper_Placeholder_Container

Details

visibility: public
final: false
static: false

toString
jump to class

toString(
           $indent
              =
              null
          )
        
        :
        string

Render the placeholder

Arguments

$indent

Output

string

Details

visibility: public
final: false
static: false

API Documentation

View/Helper/Placeholder/Container/Abstract.php

Description

Zend_View_Helper_Placeholder_Container_Abstractjump to top

Description

Constants

SETjump to class

Details

APPENDjump to class

Details

PREPENDjump to class

Details

Properties

$_captureKeyjump to class

Details

$_captureLockjump to class

Details

$_captureTypejump to class

Details

$_indentjump to class

Details

$_postfixjump to class

Details

$_prefixjump to class

Details

$_separatorjump to class

Details

Methods

__constructjump to class

Details

__toStringjump to class

Output

Details

captureEndjump to class

Details

captureStartjump to class

Arguments

Details

getIndentjump to class

Output

Details

getKeysjump to class

Output

Details

getPostfixjump to class

Output

Details

getPrefixjump to class

Output

Details

getSeparatorjump to class

Output

Details

getValuejump to class

Output

Details

getWhitespacejump to class

Arguments

Output

Details

nextIndexjump to class

Output

Details

prependjump to class

Arguments

Details

setjump to class

Arguments

Details

setIndentjump to class

Arguments

Output

Details

setPostfixjump to class

Arguments

Output

Details

setPrefixjump to class

Arguments

Output

Zend_View_Helper_Placeholder_Container_Abstract
jump to top

SET
jump to class

APPEND
jump to class

PREPEND
jump to class

$_captureKey
jump to class

$_captureLock
jump to class

$_captureType
jump to class

$_indent
jump to class

$_postfix
jump to class

$_prefix
jump to class

$_separator
jump to class

__construct
jump to class

__toString
jump to class

captureEnd
jump to class

captureStart
jump to class

getIndent
jump to class

getKeys
jump to class

getPostfix
jump to class

getPrefix
jump to class

getSeparator
jump to class

getValue
jump to class

getWhitespace
jump to class

nextIndex
jump to class

prepend
jump to class

set
jump to class

setIndent
jump to class

setPostfix
jump to class

setPrefix
jump to class

setSeparator
jump to class

toString
jump to class