API Documentation

Zend/View/Helper/Placeholder/Container/Abstract.php

Show: inherited
Table of Contents

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.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_View  
Subpackage
Helper  
Version
$Id: Abstract.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_View_Helper_Placeholder_Container_Abstract

Package: Zend\View\Helper

Abstract class representing container for placeholder values

Parent(s)
\ArrayObject
Children
\Zend_View_Helper_Placeholder_Container
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constant  SET = 'SET'

Whether or not to override all contents of placeholder

Const
string  
Constant  APPEND = 'APPEND'

Whether or not to append contents to placeholder

Const
string  
Constant  PREPEND = 'PREPEND'

Whether or not to prepend contents to placeholder

Const
string  

Properties

Propertyprotectedstring  $_captureKey= ''

Key to which to capture content

Details
Type
string
Propertyprotectedbool  $_captureLock= 'false'

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

Default valuefalseDetails
Type
bool
Propertyprotectedstring  $_captureType= ''

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

Details
Type
string
Propertyprotectedstring  $_indent= ''''

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

Default value''Details
Type
string
Propertyprotectedstring  $_postfix= ''''

What text to append the placeholder with when rendering

Default value''Details
Type
string
Propertyprotectedstring  $_prefix= ''''

What text to prefix the placeholder with when rendering

Default value''Details
Type
string
Propertyprotectedstring  $_separator= ''''

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

Default value''Details
Type
string

Methods

methodpublic__construct( ) : void

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

methodpublic__toString( ) : string

Serialize object to string

Returns
Type Description
string
methodpubliccaptureEnd( ) : void

End content capture

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

Start capturing content to push into placeholder

Parameters
Name Type Description
$type int

How to capture content into placeholder; append, prepend, or set

$key
Throws
Exception Description
\Zend_View_Helper_Placeholder_Exception if nested captures detected
methodpublicgetIndent( ) : string

Retrieve indentation

Returns
Type Description
string
methodpublicgetKeys( ) : array

Get keys

Returns
Type Description
array
methodpublicgetPostfix( ) : string

Retrieve postfix

Returns
Type Description
string
methodpublicgetPrefix( ) : string

Retrieve prefix

Returns
Type Description
string
methodpublicgetSeparator( ) : string

Retrieve separator

Returns
Type Description
string
methodpublicgetValue( ) : mixed

Retrieve container value

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

Returns
Type Description
mixed
methodpublicgetWhitespace( int|string $indent ) : string

Retrieve whitespace representation of $indent

Parameters
Name Type Description
$indent int|string
Returns
Type Description
string
methodpublicnextIndex( ) : int

Next Index

as defined by the PHP manual

Returns
Type Description
int
methodpublicprepend( mixed $value ) : void

Prepend a value to the top of the container

Parameters
Name Type Description
$value mixed
methodpublicset( mixed $value ) : void

Set a single value

Parameters
Name Type Description
$value mixed
methodpublicsetIndent( 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

Parameters
Name Type Description
$indent string|int
Returns
Type Description
\Zend_View_Helper_Placeholder_Container_Abstract
methodpublicsetPostfix( string $postfix ) : \Zend_View_Helper_Placeholder_Container

Set postfix for __toString() serialization

Parameters
Name Type Description
$postfix string
Returns
Type Description
\Zend_View_Helper_Placeholder_Container
methodpublicsetPrefix( string $prefix ) : \Zend_View_Helper_Placeholder_Container

Set prefix for __toString() serialization

Parameters
Name Type Description
$prefix string
Returns
Type Description
\Zend_View_Helper_Placeholder_Container
methodpublicsetSeparator( string $separator ) : \Zend_View_Helper_Placeholder_Container

Set separator for __toString() serialization

Used to implode elements in container

Parameters
Name Type Description
$separator string
Returns
Type Description
\Zend_View_Helper_Placeholder_Container
methodpublictoString(  $indent = null ) : string

Render the placeholder

Parameters
Name Type Description
$indent
Returns
Type Description
string
Documentation was generated by DocBlox 0.15.1.