HelpText
extends AbstractHelper
in package
"Load help text" view helper
Tags
Table of Contents
- $contentHelper : Content
- The content view helper
- $warnings : array<string|int, mixed>
- Warning messages
- __construct() : mixed
- Constructor
- getWarnings() : array<string|int, mixed>
- Get warnings generated during rendering (if any).
- render() : string|bool
- Render a help template (or return false if none found).
Properties
$contentHelper
The content view helper
protected
Content
$contentHelper
$warnings
Warning messages
protected
array<string|int, mixed>
$warnings
= []
Methods
__construct()
Constructor
public
__construct(Content $content) : mixed
Parameters
- $content : Content
-
The content view helper
Return values
mixed —getWarnings()
Get warnings generated during rendering (if any).
public
getWarnings() : array<string|int, mixed>
Return values
array<string|int, mixed> —render()
Render a help template (or return false if none found).
public
render(string $name[, array<string|int, mixed> $context = [] ]) : string|bool
Parameters
- $name : string
-
Template name to render
- $context : array<string|int, mixed> = []
-
Variables needed for rendering template; these will be temporarily added to the global view context, then reverted after the template is rendered (default = empty).