Class Placeholder

Summary

Fully Qualified Name: Laminas\View\Helper\Placeholder
Extends: AbstractHelper

Description

Helper for passing data between otherwise segregated Views. It's called Placeholder to make its typical usage obvious, but can be used just as easily for non-Placeholder things. That said, the support for this is only guaranteed to effect subsequently rendered templates, and of course Layouts.

Methods

Name Description Defined By
__invoke() Placeholder helper Placeholder
clearContainers() Remove all containers Placeholder
containerExists() Does a particular container exist? Placeholder
createContainer() createContainer Placeholder
deleteContainer() Delete a specific container by name Placeholder
getContainer() Retrieve a placeholder container Placeholder
getView() Get the view object AbstractHelper
setView() Set the View object AbstractHelper

Method Details

__invoke()

Placeholder helper

Parameter Name Type Description
$name string

Returns: \Placeholder\Container\AbstractContainer

clearContainers()

Remove all containers

Returns: void

containerExists()

Does a particular container exist?

Parameter Name Type Description
$key string

Returns: bool

createContainer()

createContainer

Parameter Name Type Description
$key string
$value array

Returns: \Container\AbstractContainer

deleteContainer()

Delete a specific container by name

Parameter Name Type Description
$key string

Returns: void

getContainer()

Retrieve a placeholder container

Parameter Name Type Description
$key string

Returns: \Container\AbstractContainer

getView()

Get the view object

Returns: null|\Renderer

setView()

Set the View object

Parameter Name Type Description
$view \Renderer

Returns: \AbstractHelper

Top