View/Helper/Placeholder/Container/Abstract.php

Show:

inherited

Classes
- \Zend_View_Helper_Placeholder_Container_Abstract

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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_View
Subpackage: Helper
Version: $Id$

\Zend_View_Helper_Placeholder_Container_Abstract
jump to top

Package: Zend_View\Helper

Abstract class representing container for placeholder values

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

Constants

 
                SET
                = 'SET'

Whether or not to override all contents of placeholder

Const: string

 
                APPEND
                = 'APPEND'

Whether or not to append contents to placeholder

Const: string

 
                PREPEND
                = 'PREPEND'

Whether or not to prepend contents to placeholder

Const: string

Properties

string $_captureKey

Key to which to capture content

Details

Type: string

bool $_captureLock = false

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

Default valuefalseDetails

Type: bool

string $_captureType

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

Details

Type: string

string $_indent = ''

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

Default value''Details

Type: string

string $_postfix = ''

What text to append the placeholder with when rendering

Default value''Details

Type: string

string $_prefix = ''

What text to prefix the placeholder with when rendering

Default value''Details

Type: string

string $_separator = ''

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

Default value''Details

Type: string

Methods

__construct() : \Zend_View_Helper_Placeholder_Container_Abstract

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

Returns

Type	Description
\Zend_View_Helper_Placeholder_Container_Abstract

__toString() : string

Serialize object to string

Returns

Type	Description
string

captureEnd() : void

End content capture

captureStart(int | string $type = \Zend_View_Helper_Placeholder_Container_Abstract::APPEND, null $key = null) : void

Start capturing content to push into placeholder

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

Retrieve indentation

Returns

Type	Description
string

getKeys() : array

Get keys

Returns

Type	Description
array

getPostfix() : string

Retrieve postfix

Returns

Type	Description
string

getPrefix() : string

Retrieve prefix

Returns

Type	Description
string

getSeparator() : string

Retrieve separator

Returns

Type	Description
string

getValue() : mixed

Retrieve container value

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

Returns

Type	Description
mixed

getWhitespace(int | string $indent) : string

Retrieve whitespace representation of $indent

Parameters

Name	Type	Description
$indent	int \| string

Returns

Type	Description
string

nextIndex() : int

Next Index

as defined by the PHP manual

Returns

Type	Description
int

prepend(mixed $value) : void

Prepend a value to the top of the container

Parameters

Name	Type	Description
$value	mixed

set(mixed $value) : void

Set a single value

Parameters

Name	Type	Description
$value	mixed

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

Parameters

Name	Type	Description
$indent	string \| int

Returns

Type	Description
\Zend_View_Helper_Placeholder_Container_Abstract

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

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

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

toString(null $indent = null) : string

Render the placeholder

Parameters

Name	Type	Description
$indent	null

Returns

Type	Description
string

View/Helper/Placeholder/Container/Abstract.php

\Zend_View_Helper_Placeholder_Container_Abstractjump to top

Constants

Properties

Methods

\Zend_View_Helper_Placeholder_Container_Abstract
jump to top