View/Helper/Placeholder/Container.php

Show: PublicProtectedPrivateinherited
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: Container.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_View_Helper_Placeholder_Container

Package: Zend\View\Helper
Container for placeholder values
Parent(s)
\Zend_View_Helper_Placeholder_Container_Abstract < \ArrayObject
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  SET = 'SET'
inherited
Whether or not to override all contents of placeholder
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::SET
>VConstant  APPEND = 'APPEND'
inherited
Whether or not to append contents to placeholder
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::APPEND
>VConstant  PREPEND = 'PREPEND'
inherited
Whether or not to prepend contents to placeholder
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::PREPEND

Properties

>VPropertyprotectedstring $_captureKey
inherited
Key to which to capture content
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::$$_captureKey
>VPropertyprotectedbool $_captureLock = false
inherited
Whether or not we're already capturing for this given container
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::$$_captureLock
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_View_Helper_Placeholder_Container_Abstract::$$_captureLock  
>VPropertyprotectedstring $_captureType
inherited
What type of capture (overwrite (set), append, prepend) to use
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::$$_captureType
>VPropertyprotectedstring $_indent = ''
inherited
What string to use as the indentation of output, this will typically be spaces.
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::$$_indent

Eg: ' '

Default value''Details
Type
string
Inherited_from
\Zend_View_Helper_Placeholder_Container_Abstract::$$_indent  
>VPropertyprotectedstring $_postfix = ''
inherited
What text to append the placeholder with when rendering
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::$$_postfix
Default value''Details
Type
string
Inherited_from
\Zend_View_Helper_Placeholder_Container_Abstract::$$_postfix  
>VPropertyprotectedstring $_prefix = ''
inherited
What text to prefix the placeholder with when rendering
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::$$_prefix
Default value''Details
Type
string
Inherited_from
\Zend_View_Helper_Placeholder_Container_Abstract::$$_prefix  
>VPropertyprotectedstring $_separator = ''
inherited
What string to use between individual items in the placeholder when rendering
Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::$$_separator
Default value''Details
Type
string
Inherited_from
\Zend_View_Helper_Placeholder_Container_Abstract::$$_separator  

Methods

methodpublic__construct() : \Zend_View_Helper_Placeholder_Container_Abstract
inherited

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

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::__construct()
methodpublic__toString() : string
inherited

Serialize object to string

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::__toString()
Returns
TypeDescription
string
methodpubliccaptureEnd() : void
inherited

End content capture

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::captureEnd()
methodpubliccaptureStart(int | string $type = \Zend_View_Helper_Placeholder_Container_Abstract::APPEND, null $key = null) : void
inherited

Start capturing content to push into placeholder

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::captureStart()
Parameters
NameTypeDescription
$typeint | string

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

$keynull
Throws
ExceptionDescription
\Zend_View_Helper_Placeholder_Container_Exception
methodpublicgetIndent() : string
inherited

Retrieve indentation

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::getIndent()
Returns
TypeDescription
string
methodpublicgetKeys() : array
Returns
TypeDescription
array
methodpublicgetPostfix() : string
Returns
TypeDescription
string
methodpublicgetPrefix() : string
Returns
TypeDescription
string
methodpublicgetSeparator() : string
inherited

Retrieve separator

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::getSeparator()
Returns
TypeDescription
string
methodpublicgetValue() : mixed
inherited

Retrieve container value

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::getValue()

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

Returns
TypeDescription
mixed
methodpublicgetWhitespace(int | string $indent) : string
inherited

Retrieve whitespace representation of $indent

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::getWhitespace()
Parameters
NameTypeDescription
$indentint | string
Returns
TypeDescription
string
methodpublicnextIndex() : int

as defined by the PHP manual

Returns
TypeDescription
int
methodpublicprepend(mixed $value) : void
inherited

Prepend a value to the top of the container

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::prepend()
Parameters
NameTypeDescription
$valuemixed
methodpublicset(mixed $value) : void
inherited

Set a single value

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::set()
Parameters
NameTypeDescription
$valuemixed
methodpublicsetIndent(string | int $indent) : \Zend_View_Helper_Placeholder_Container_Abstract
inherited

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

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::setIndent()
Parameters
NameTypeDescription
$indentstring | int
Returns
TypeDescription
\Zend_View_Helper_Placeholder_Container_Abstract
methodpublicsetPostfix(string $postfix) : \Zend_View_Helper_Placeholder_Container
inherited

Set postfix for __toString() serialization

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::setPostfix()
Parameters
NameTypeDescription
$postfixstring
Returns
TypeDescription
\Zend_View_Helper_Placeholder_Container
methodpublicsetPrefix(string $prefix) : \Zend_View_Helper_Placeholder_Container
inherited

Set prefix for __toString() serialization

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::setPrefix()
Parameters
NameTypeDescription
$prefixstring
Returns
TypeDescription
\Zend_View_Helper_Placeholder_Container
methodpublicsetSeparator(string $separator) : \Zend_View_Helper_Placeholder_Container
inherited

Set separator for __toString() serialization

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::setSeparator()

Used to implode elements in container

Parameters
NameTypeDescription
$separatorstring
Returns
TypeDescription
\Zend_View_Helper_Placeholder_Container
methodpublictoString(null $indent = null) : string
inherited

Render the placeholder

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::toString()
Parameters
NameTypeDescription
$indentnull
Returns
TypeDescription
string
Documentation was generated by phpDocumentor 2.0.0a12.