ClassConstantIterator
in package
implements
Iterator
This class acts like a combination of a ClassConst and Const_ to be able to create constant descriptors using a normal strategy.
Tags
Interfaces, Classes and Traits
- Iterator
Table of Contents
- $classConstants : ClassConst
- $index : int
- __construct() : mixed
- Initializes the class with source data.
- current() : self
- getDocComment() : Doc|null
- Gets the doc comment of the node.
- getEndLine() : int
- Gets line the node ended in.
- getFqsen() : Fqsen
- Returns the fqsen of the current constant.
- getLine() : int
- Gets line the node started in.
- getName() : string
- Returns the name of the current constant.
- getValue() : Expr
- isFinal() : bool
- isPrivate() : bool
- returns true when the current property is private.
- isProtected() : bool
- returns true when the current property is protected.
- isPublic() : bool
- returns true when the current property is public.
- key() : int|null
- next() : void
- rewind() : void
- valid() : bool
Properties
$classConstants
private
ClassConst
$classConstants
$index
private
int
$index
= 0
index of the current ClassConst to use
Methods
__construct()
Initializes the class with source data.
public
__construct(ClassConst $classConst) : mixed
Parameters
- $classConst : ClassConst
Return values
mixed —current()
public
current() : self
Tags
Return values
self —getDocComment()
Gets the doc comment of the node.
public
getDocComment() : Doc|null
The doc comment has to be the last comment associated with the node.
Return values
Doc|null —getEndLine()
Gets line the node ended in.
public
getEndLine() : int
Return values
int —Line
getFqsen()
Returns the fqsen of the current constant.
public
getFqsen() : Fqsen
Return values
Fqsen —getLine()
Gets line the node started in.
public
getLine() : int
Return values
int —Line
getName()
Returns the name of the current constant.
public
getName() : string
Return values
string —getValue()
public
getValue() : Expr
Return values
Expr —isFinal()
public
isFinal() : bool
Return values
bool —isPrivate()
returns true when the current property is private.
public
isPrivate() : bool
Return values
bool —isProtected()
returns true when the current property is protected.
public
isProtected() : bool
Return values
bool —isPublic()
returns true when the current property is public.
public
isPublic() : bool
Return values
bool —key()
public
key() : int|null
Tags
Return values
int|null —next()
public
next() : void
Tags
Return values
void —rewind()
public
rewind() : void
Tags
Return values
void —valid()
public
valid() : bool