Lines
extends Collection
in package
Table of Contents
Properties
- $index : int
Methods
- advance() : string|null
- Advances to the next usable line and returns the new line
- consume() : string|null
- Similar to the above advance() method, except this returns the CURRENT line before advancing
- consumeItems() : Items
- consumeUntil() : Collection
- current() : string|null
- currentIsBlank() : bool
- hasItems() : bool
- isDivider() : bool
- isGroupTitle() : bool
- isModuleName() : bool
- isNote() : bool
- isTableHeading() : bool
- items() : Items
- next() : string|null
- nextIsBlank() : bool
- previous() : string|null
- previousIsBlank() : bool
- shouldIgnore() : bool
- startAt() : string|null
- step() : string|null
- Moves one line forward, regardless of what it is
Properties
$index
protected
int
$index
= 0
Methods
advance()
Advances to the next usable line and returns the new line
public
advance() : string|null
Return values
string|nullconsume()
Similar to the above advance() method, except this returns the CURRENT line before advancing
public
consume() : string|null
Return values
string|nullconsumeItems()
public
consumeItems() : Items
Return values
ItemsconsumeUntil()
public
consumeUntil(callable $callback) : Collection
Parameters
- $callback : callable
Return values
Collectioncurrent()
public
current() : string|null
Return values
string|nullcurrentIsBlank()
public
currentIsBlank() : bool
Return values
boolhasItems()
public
hasItems() : bool
Return values
boolisDivider()
public
isDivider() : bool
Return values
boolisGroupTitle()
public
isGroupTitle() : bool
Return values
boolisModuleName()
public
isModuleName() : bool
Return values
boolisNote()
public
isNote() : bool
Return values
boolisTableHeading()
public
isTableHeading() : bool
Return values
boolitems()
public
items() : Items
Return values
Itemsnext()
public
next() : string|null
Return values
string|nullnextIsBlank()
public
nextIsBlank() : bool
Return values
boolprevious()
public
previous() : string|null
Return values
string|nullpreviousIsBlank()
public
previousIsBlank() : bool
Return values
boolshouldIgnore()
public
shouldIgnore() : bool
Return values
boolstartAt()
public
startAt(mixed $contents) : string|null
Parameters
- $contents : mixed
Return values
string|nullstep()
Moves one line forward, regardless of what it is
public
step() : string|null