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

a result is a little more than just a PASS/FAIL: 1. we need to know what happened during this phase 2. we need to know how this affects the playing of the story 3. we need to know if there are any other phases we need to execute *because* we have executed this phase 4. we need to know if there's a message to pass on to the end-user perhaps it was much easier when we just hard-coded all of this?
Автор: Stuart Herbert ([email protected])
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$activityLog

Защищенные свойства (Protected)

Свойство Тип Описание
$exception
$message
$nextAction
$phaseName
$result
$resultTextMap

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

Метод Описание
__construct ( $phaseName )
getException ( ) : Exception | null
getMessage ( ) : string | null
getNextAction ( ) : integer
getPhaseCannotRun ( ) : boolean
getPhaseCompleted ( ) : boolean
getPhaseFailed ( ) : boolean
getPhaseHasBeenSkipped ( ) : boolean
getPhaseHasNoActions ( ) : boolean
getPhaseIsBlacklisted ( ) : boolean
getPhaseIsIncomplete ( ) : boolean
getPhaseName ( ) : string
getPhaseResult ( ) : integer
getPhaseResultString ( ) : string
getPhaseSucceeded ( ) : boolean
hasMessage ( ) : boolean
setContinuePlaying ( integer $result = 1, string | null $msg = null, Exceptio\Exception | null $e = null ) : void
setPlayingFailed ( integer $result, string $msg, Exceptio\Exception | null $e = null ) : void
setSkipPlaying ( integer $result, string $msg, $e = null ) : void

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

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

public __construct ( $phaseName )

getException() публичный Метод

public getException ( ) : Exception | null
Результат Exception | null

getMessage() публичный Метод

public getMessage ( ) : string | null
Результат string | null

getNextAction() публичный Метод

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

getPhaseCannotRun() публичный Метод

public getPhaseCannotRun ( ) : boolean
Результат boolean

getPhaseCompleted() публичный Метод

public getPhaseCompleted ( ) : boolean
Результат boolean

getPhaseFailed() публичный Метод

public getPhaseFailed ( ) : boolean
Результат boolean

getPhaseHasBeenSkipped() публичный Метод

public getPhaseHasBeenSkipped ( ) : boolean
Результат boolean

getPhaseHasNoActions() публичный Метод

public getPhaseHasNoActions ( ) : boolean
Результат boolean

getPhaseIsBlacklisted() публичный Метод

public getPhaseIsBlacklisted ( ) : boolean
Результат boolean

getPhaseIsIncomplete() публичный Метод

public getPhaseIsIncomplete ( ) : boolean
Результат boolean

getPhaseName() публичный Метод

public getPhaseName ( ) : string
Результат string

getPhaseResult() публичный Метод

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

getPhaseResultString() публичный Метод

public getPhaseResultString ( ) : string
Результат string

getPhaseSucceeded() публичный Метод

public getPhaseSucceeded ( ) : boolean
Результат boolean

hasMessage() публичный Метод

public hasMessage ( ) : boolean
Результат boolean

setContinuePlaying() публичный Метод

public setContinuePlaying ( integer $result = 1, string | null $msg = null, Exceptio\Exception | null $e = null ) : void
$result integer
$msg string | null
$e Exceptio\Exception | null
Результат void

setPlayingFailed() публичный Метод

public setPlayingFailed ( integer $result, string $msg, Exceptio\Exception | null $e = null ) : void
$result integer
$msg string
$e Exceptio\Exception | null
Результат void

setSkipPlaying() публичный Метод

public setSkipPlaying ( integer $result, string $msg, $e = null ) : void
$result integer
$msg string
Результат void

Описание свойств

$activityLog публичное свойство

public $activityLog

$exception защищенное свойство

protected $exception

$message защищенное свойство

protected $message

$nextAction защищенное свойство

protected $nextAction

$phaseName защищенное свойство

protected $phaseName

$result защищенное свойство

protected $result

$resultTextMap защищенное свойство

protected $resultTextMap