View/Helper/Placeholder/Container.php

Show:

inherited

Classes
- \Zend_View_Helper_Placeholder_Container

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
jump to top

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

 
                SET
                = 'SET'

inherited

Whether or not to override all contents of placeholder

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::SET

Const: string
Inherited_from: \Zend_View_Helper_Placeholder_Container_Abstract::SET

 
                APPEND
                = 'APPEND'

inherited

Whether or not to append contents to placeholder

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::APPEND

Const: string
Inherited_from: \Zend_View_Helper_Placeholder_Container_Abstract::APPEND

 
                PREPEND
                = 'PREPEND'

inherited

Whether or not to prepend contents to placeholder

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::PREPEND

Const: string
Inherited_from: \Zend_View_Helper_Placeholder_Container_Abstract::PREPEND

Properties

string $_captureKey

inherited

Key to which to capture content

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::$$_captureKey

Details

Type: string
Inherited_from: \Zend_View_Helper_Placeholder_Container_Abstract::$$_captureKey

bool $_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

string $_captureType

inherited

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

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::$$_captureType

Details

Type: string
Inherited_from: \Zend_View_Helper_Placeholder_Container_Abstract::$$_captureType

string $_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

string $_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

string $_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

string $_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

__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()

Returns

Type	Description
\Zend_View_Helper_Placeholder_Container_Abstract

__toString() : string

inherited

Serialize object to string

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::__toString()

Returns

Type	Description
string

captureEnd() : void

inherited

End content capture

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::captureEnd()

captureStart(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

Name	Type	Description
$type	int \| string	How to capture content into placeholder; append, prepend, or set
$key	null

Throws

Exception	Description
\Zend_View_Helper_Placeholder_Container_Exception

getIndent() : string

inherited

Retrieve indentation

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::getIndent()

Returns

Type	Description
string

getKeys() : array

inherited

Get keys

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::getKeys()

Returns

Type	Description
array

getPostfix() : string

inherited

Retrieve postfix

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::getPostfix()

Returns

Type	Description
string

getPrefix() : string

inherited

Retrieve prefix

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::getPrefix()

Returns

Type	Description
string

getSeparator() : string

inherited

Retrieve separator

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::getSeparator()

Returns

Type	Description
string

getValue() : 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

Type	Description
mixed

getWhitespace(int | string $indent) : string

inherited

Retrieve whitespace representation of $indent

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::getWhitespace()

Parameters

Name	Type	Description
$indent	int \| string

Returns

Type	Description
string

nextIndex() : int

inherited

Next Index

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::nextIndex()

as defined by the PHP manual

Returns

Type	Description
int

prepend(mixed $value) : void

inherited

Prepend a value to the top of the container

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::prepend()

Parameters

Name	Type	Description
$value	mixed

set(mixed $value) : void

inherited

Set a single value

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::set()

Parameters

Name	Type	Description
$value	mixed

setIndent(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

Name	Type	Description
$indent	string \| int

Returns

Type	Description
\Zend_View_Helper_Placeholder_Container_Abstract

setPostfix(string $postfix) : \Zend_View_Helper_Placeholder_Container

inherited

Set postfix for __toString() serialization

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::setPostfix()

Parameters

Name	Type	Description
$postfix	string

Returns

Type	Description
\Zend_View_Helper_Placeholder_Container

setPrefix(string $prefix) : \Zend_View_Helper_Placeholder_Container

inherited

Set prefix for __toString() serialization

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::setPrefix()

Parameters

Name	Type	Description
$prefix	string

Returns

Type	Description
\Zend_View_Helper_Placeholder_Container

setSeparator(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

Name	Type	Description
$separator	string

Returns

Type	Description
\Zend_View_Helper_Placeholder_Container

toString(null $indent = null) : string

inherited

Render the placeholder

Inherited from: \Zend_View_Helper_Placeholder_Container_Abstract::toString()

Parameters

Name	Type	Description
$indent	null

Returns

Type	Description
string

View/Helper/Placeholder/Container.php

\Zend_View_Helper_Placeholder_Containerjump to top

Constants

Properties

Methods

\Zend_View_Helper_Placeholder_Container
jump to top