Documentation

Horde_View_Helper_Block extends Horde_View_Helper_Base
in package

View helper for displaying Horde block objects.

Tags
author

Chuck Hagenbuch chuck@horde.org

category

Horde

subpackage

Helper

Table of Contents

$_blockCache  : array<string|int, mixed>
Blocks that have already been fetched.
$_view  : Horde_View
The parent view invoking the helper.
__call()  : mixed
Call chaining so members of the view can be called (including other helpers).
__construct()  : mixed
Creates a helper for $view.
__get()  : mixed
Proxy on undefined property access (get).
__set()  : mixed
Proxy on undefined property access (set).
blockContent()  : string
Returns the content of the specified block.
blockTitle()  : string
Returns the title of the specified block.
_args()  : mixed
Parses any argument style for the Block-fetching functions.
_block()  : Horde_Core_Block
Instantiates and caches Block objects.

Properties

$_blockCache

Blocks that have already been fetched.

protected array<string|int, mixed> $_blockCache = array()

Methods

__call()

Call chaining so members of the view can be called (including other helpers).

public __call(string $method, array<string|int, mixed> $args) : mixed
Parameters
$method : string

The method.

$args : array<string|int, mixed>

The parameters for the method.

Return values
mixed

The result of the method.

__construct()

Creates a helper for $view.

public __construct(Horde_View $view) : mixed
Parameters
$view : Horde_View

The view to help.

Return values
mixed

__get()

Proxy on undefined property access (get).

public __get(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed

__set()

Proxy on undefined property access (set).

public __set(mixed $name, mixed $value) : mixed
Parameters
$name : mixed
$value : mixed
Return values
mixed

blockContent()

Returns the content of the specified block.

public blockContent() : string
Tags
throws
Horde_View_Exception
throws
InvalidArgumentException
Return values
string

The requested Block's content.

blockTitle()

Returns the title of the specified block.

public blockTitle() : string
Tags
throws
Horde_View_Exception
throws
InvalidArgumentException
Return values
string

The requested Block's title.

_args()

Parses any argument style for the Block-fetching functions.

protected _args(array<string|int, mixed> $args) : mixed
Parameters
$args : array<string|int, mixed>
Return values
mixed

_block()

Instantiates and caches Block objects.

protected _block(string $block, array<string|int, mixed> $params) : Horde_Core_Block
Parameters
$block : string

The name of the block to fetch.

$params : array<string|int, mixed>

Any arguments to the Block constructor.

Tags
throws
Horde_View_Exception
Return values
Horde_Core_Block

The requested Block object.

Search results