PHP Класс DataSift\Storyplayer\PlayerLib\Action_LogItem

Автор: Stuart Herbert ([email protected])
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
__construct ( DataSift\Storyplayer\Injectables $injectables, integer $nestLevel )
addStep ( string $text, callback $callable ) : mixed
captureOutput ( $text ) : void
closeAllOpenSubActions ( ) : void
endAction ( mixed $message = null )
endStep ( ) : void
getEndTime ( ) : float | null
getIsComplete ( ) : boolean
getIsOpen ( ) : boolean
getNestLevel ( ) : integer
getOpenAction ( ) : Action_LogItem | null
getStartTime ( ) : float | null
newNestedAction ( ) : Action_LogItem
startAction ( mixed $message, array | null $codeLine = null ) : Action_LogItem
startStep ( $text ) : void

Защищенные методы

Метод Описание
writeToLog ( $text, $codeLine = null ) : void

Описание методов

__construct() публичный метод

public __construct ( DataSift\Storyplayer\Injectables $injectables, integer $nestLevel )
$injectables DataSift\Storyplayer\Injectables
$nestLevel integer

addStep() публичный метод

public addStep ( string $text, callback $callable ) : mixed
$text string the message to write
$callable callback the function / lambda to call
Результат mixed

captureOutput() публичный метод

public captureOutput ( $text ) : void
Результат void

closeAllOpenSubActions() публичный метод

public closeAllOpenSubActions ( ) : void
Результат void

endAction() публичный метод

public endAction ( mixed $message = null )
$message mixed

endStep() публичный метод

public endStep ( ) : void
Результат void

getEndTime() публичный метод

public getEndTime ( ) : float | null
Результат float | null

getIsComplete() публичный метод

public getIsComplete ( ) : boolean
Результат boolean TRUE if the action is complete FALSE if the action is currently in progress or has never been started

getIsOpen() публичный метод

public getIsOpen ( ) : boolean
Результат boolean TRUE if the action is currently in progress FALSE if the action is complete or has never been started

getNestLevel() публичный метод

public getNestLevel ( ) : integer
Результат integer

getOpenAction() публичный метод

public getOpenAction ( ) : Action_LogItem | null
Результат Action_LogItem | null

getStartTime() публичный метод

public getStartTime ( ) : float | null
Результат float | null

newNestedAction() публичный метод

public newNestedAction ( ) : Action_LogItem
Результат Action_LogItem

startAction() публичный метод

public startAction ( mixed $message, array | null $codeLine = null ) : Action_LogItem
$message mixed the message to log. if it isn't a string, we'll convert it and apply the user's -V preference before logging
$codeLine array | null metadata about the line of code that we're logging about
Результат Action_LogItem return $this for fluent interfaces

startStep() публичный метод

public startStep ( $text ) : void
Результат void

writeToLog() защищенный метод

protected writeToLog ( $text, $codeLine = null ) : void
Результат void