PropertyEnumerator
extends Enumerator
in package
Property 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.
- getKindLabel() : string
- Get a label for the particular kind of "class" represented.
- getProperties() : array<string|int, mixed>
- Get defined properties for the given class or object Reflector.
- listItems() : array<string|int, mixed>
- Enumerate specific items with the given input options and target.
- prepareProperties() : array<string|int, mixed>
- Prepare formatted property array.
- presentRef() : mixed
- presentSignature() : mixed
- presentValue() : string
- Present the $target's current value for a reflection property.
- showItem() : mixed
- getVisibilityStyle() : string
- Get output style for the given property's visibility.
Constants
IS_CLASS
public
mixed
IS_CLASS
= 'class'
IS_CONSTANT
public
mixed
IS_CONSTANT
= 'const'
IS_FUNCTION
public
mixed
IS_FUNCTION
= 'function'
IS_GLOBAL
public
mixed
IS_GLOBAL
= 'global'
IS_PRIVATE
public
mixed
IS_PRIVATE
= 'private'
IS_PROTECTED
public
mixed
IS_PROTECTED
= 'protected'
IS_PUBLIC
public
mixed
IS_PUBLIC
= 'public'
Properties
$filter
private
mixed
$filter
$presenter
private
mixed
$presenter
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> —getKindLabel()
Get a label for the particular kind of "class" represented.
protected
getKindLabel(ReflectionClass $reflector) : string
Parameters
- $reflector : ReflectionClass
Return values
string —getProperties()
Get defined properties for the given class or object Reflector.
protected
getProperties(bool $showAll, Reflector $reflector[, bool $noInherit = false ]) : array<string|int, mixed>
Parameters
- $showAll : bool
-
Include private and protected properties
- $reflector : Reflector
- $noInherit : bool = false
-
Exclude inherited properties
Return values
array<string|int, mixed> —listItems()
Enumerate specific items with the given input options and target.
protected
listItems(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> —prepareProperties()
Prepare formatted property array.
protected
prepareProperties(array<string|int, mixed> $properties[, mixed $target = null ]) : array<string|int, mixed>
Parameters
- $properties : array<string|int, mixed>
- $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 —presentValue()
Present the $target's current value for a reflection property.
protected
presentValue(ReflectionProperty $property, mixed $target) : string
Parameters
- $property : ReflectionProperty
- $target : mixed
Return values
string —showItem()
protected
showItem(mixed $name) : mixed
Parameters
- $name : mixed
Return values
mixed —getVisibilityStyle()
Get output style for the given property's visibility.
private
getVisibilityStyle(ReflectionProperty $property) : string
Parameters
- $property : ReflectionProperty