HelperSet
in package
implements
IteratorAggregate
HelperSet represents a set of helpers to be used with a command.
Tags
Table of Contents
Interfaces
- IteratorAggregate
Properties
Methods
- __construct() : mixed
- Constructor.
- get() : HelperInterface
- Gets a helper value.
- getCommand() : Command
- Gets the command associated with this helper set.
- getIterator() : array<string|int, Helper>
- has() : bool
- Returns true if the helper if defined.
- set() : mixed
- Sets a helper.
- setCommand() : mixed
- Sets the command associated with this helper set.
Properties
$command
private
mixed
$command
$helpers
private
array<string|int, Helper>
$helpers
= array()
Methods
__construct()
Constructor.
public
__construct([array<string|int, Helper> $helpers = array() ]) : mixed
Parameters
- $helpers : array<string|int, Helper> = array()
-
An array of helper
get()
Gets a helper value.
public
get(string $name) : HelperInterface
Parameters
- $name : string
-
The helper name
Tags
Return values
HelperInterface —The helper instance
getCommand()
Gets the command associated with this helper set.
public
getCommand() : Command
Return values
Command —A Command instance
getIterator()
public
getIterator() : array<string|int, Helper>
Return values
array<string|int, Helper>has()
Returns true if the helper if defined.
public
has(string $name) : bool
Parameters
- $name : string
-
The helper name
Return values
bool —true if the helper is defined, false otherwise
set()
Sets a helper.
public
set(HelperInterface $helper[, string $alias = null ]) : mixed
Parameters
- $helper : HelperInterface
-
The helper instance
- $alias : string = null
-
An alias
setCommand()
Sets the command associated with this helper set.
public
setCommand([Command $command = null ]) : mixed
Parameters
- $command : Command = null
-
A Command instance