Documentation

Enumerator
in package

Abstract Enumerator class.

Table of Contents

IS_CLASS  = 'class'
IS_CONSTANT  = 'const'
IS_FUNCTION  = 'function'
IS_GLOBAL  = 'global'
IS_PRIVATE  = 'private'
IS_PROTECTED  = 'protected'
IS_PUBLIC  = 'public'
$filter  : mixed
$presenter  : mixed
__construct()  : mixed
Enumerator constructor.
enumerate()  : array<string|int, mixed>
Return a list of categorized things with the given input options and target.
listItems()  : array<string|int, mixed>
Enumerate specific items with the given input options and target.
presentRef()  : mixed
presentSignature()  : mixed
showItem()  : mixed

Constants

IS_FUNCTION

public mixed IS_FUNCTION = 'function'

IS_PROTECTED

public mixed IS_PROTECTED = 'protected'

Properties

Methods

__construct()

Enumerator constructor.

public __construct(Presenter $presenter) : mixed
Parameters
$presenter : Presenter
Return values
mixed —

enumerate()

Return a list of categorized things with the given input options and target.

public enumerate(InputInterface $input[, Reflector $reflector = null ][, mixed $target = null ]) : array<string|int, mixed>
Parameters
$input : InputInterface
$reflector : Reflector = null
$target : mixed = null
Return values
array<string|int, mixed> —

listItems()

Enumerate specific items with the given input options and target.

protected abstract listItems(InputInterface $input[, Reflector $reflector = null ][, mixed $target = null ]) : array<string|int, mixed>

Implementing classes should return an array of arrays:

[ 'Constants' => [ 'FOO' => [ 'name' => 'FOO', 'style' => 'public', 'value' => '123', ], ], ]

Parameters
$input : InputInterface
$reflector : Reflector = null
$target : mixed = null
Return values
array<string|int, mixed> —

presentRef()

protected presentRef(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

presentSignature()

protected presentSignature(mixed $target) : mixed
Parameters
$target : mixed
Return values
mixed —

showItem()

protected showItem(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed —

Search results