Step
in package
Description of Step
Tags
Table of Contents
- SPACE_PREFIX = ' '
- TYPE_DOTTER = 'dotter'
- TYPE_SPACER = 'spacer'
- $count : int
- $depth : int
- $message : string
- $outputType : string
- $parent : Step
- $steps : array<string|int, mixed>
- createSubStep() : mixed
- factory() : mixed
- Factory method for outputting basic messages.
- getCount() : mixed
- getDepth() : mixed
- getMessage() : mixed
- getOutput() : mixed
- getOutputType() : mixed
- getParent() : mixed
- output() : mixed
- setCount() : mixed
- setDepth() : mixed
- setMessage() : mixed
- setOutputType() : mixed
- setParent() : mixed
- stepInfo() : mixed
- stepInfoDotter() : mixed
- subStep() : mixed
- computeSpacePrefix() : mixed
Constants
SPACE_PREFIX
public
mixed
SPACE_PREFIX
= ' '
TYPE_DOTTER
public
mixed
TYPE_DOTTER
= 'dotter'
TYPE_SPACER
public
mixed
TYPE_SPACER
= 'spacer'
Properties
$count
public
int
$count
= 1
The count for this step.
$depth
public
int
$depth
= 0
How far down the rabbit hole is this step?
$message
public
string
$message
The content to be outputted.
$outputType
public
string
$outputType
Either default, spacer or dotter.
$parent
public
Step
$parent
The parent of this step.
$steps
public
array<string|int, mixed>
$steps
= array()
Child steps.
Methods
createSubStep()
public
createSubStep(mixed $string[, mixed $outputType = null ]) : mixed
Parameters
- $string : mixed
- $outputType : mixed = null
Return values
mixed —factory()
Factory method for outputting basic messages.
public
static factory(mixed $message[, mixed $count = 1 ]) : mixed
Parameters
- $message : mixed
- $count : mixed = 1
Return values
mixed —getCount()
public
getCount() : mixed
Return values
mixed —getDepth()
public
getDepth() : mixed
Return values
mixed —getMessage()
public
getMessage() : mixed
Return values
mixed —getOutput()
public
getOutput() : mixed
Return values
mixed —getOutputType()
public
getOutputType() : mixed
Return values
mixed —getParent()
public
getParent() : mixed
Return values
mixed —output()
public
output() : mixed
Return values
mixed —setCount()
public
setCount(mixed $count) : mixed
Parameters
- $count : mixed
Return values
mixed —setDepth()
public
setDepth(mixed $depth) : mixed
Parameters
- $depth : mixed
Return values
mixed —setMessage()
public
setMessage(mixed $message) : mixed
Parameters
- $message : mixed
Return values
mixed —setOutputType()
public
setOutputType(mixed $outputType) : mixed
Parameters
- $outputType : mixed
Return values
mixed —setParent()
public
setParent(Step $step) : mixed
Parameters
- $step : Step
Return values
mixed —stepInfo()
public
stepInfo() : mixed
Return values
mixed —stepInfoDotter()
public
stepInfoDotter() : mixed
Return values
mixed —subStep()
public
subStep(mixed $message) : mixed
Parameters
- $message : mixed
Return values
mixed —computeSpacePrefix()
private
computeSpacePrefix() : mixed