PHP 클래스 Pantheon\Terminus\Models\Workflow

상속: extends TerminusModel, implements League\Container\ContainerAwareInterface, implements Pantheon\Terminus\Session\SessionAwareInterface, use trait League\Container\ContainerAwareTrait, use trait Pantheon\Terminus\Session\SessionAwareTrait
파일 보기 프로젝트 열기: pantheon-systems/terminus 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$owner mixed

공개 메소드들

메소드 설명
__construct ( object $attributes = null, array $options = [] ) : Workflow Object constructor
checkProgress ( ) : boolean Check on the progress of a workflow. This can be called repeatedly and will apply a polling period to prevent flooding the API with requests.
fetchWithLogs ( ) : Workflow Re-fetches workflow data hydrated with logs
getMessage ( ) : string Get the success message of a workflow or throw an exception of the workflow failed.
getStatus ( ) : string Returns the status of this workflow
getUrl ( ) : string Get the URL for this model
isFinished ( ) : boolean Detects if the workflow has finished
isSuccessful ( ) : boolean Detects if the workflow was successful
operations ( ) : WorkflowOperation[] Returns a list of WorkflowOperations for this workflow
serialize ( ) : array Formats workflow object into an associative array for output
wait ( ) : Workflow | void Waits on this workflow to finish

비공개 메소드들

메소드 설명
poll ( ) : void Fetches this object from Pantheon. Waits a given length of time between checks.

메소드 상세

__construct() 공개 메소드

Object constructor
public __construct ( object $attributes = null, array $options = [] ) : Workflow
$attributes object Attributes of this model
$options array Options with which to configure this model
리턴 Workflow

checkProgress() 공개 메소드

Check on the progress of a workflow. This can be called repeatedly and will apply a polling period to prevent flooding the API with requests.
public checkProgress ( ) : boolean
리턴 boolean Whether the workflow is finished or not

fetchWithLogs() 공개 메소드

Re-fetches workflow data hydrated with logs
public fetchWithLogs ( ) : Workflow
리턴 Workflow

getMessage() 공개 메소드

Get the success message of a workflow or throw an exception of the workflow failed.
public getMessage ( ) : string
리턴 string The message to output to the user

getStatus() 공개 메소드

Returns the status of this workflow
public getStatus ( ) : string
리턴 string

getUrl() 공개 메소드

Get the URL for this model
public getUrl ( ) : string
리턴 string

isFinished() 공개 메소드

Detects if the workflow has finished
public isFinished ( ) : boolean
리턴 boolean True if workflow has finished

isSuccessful() 공개 메소드

Detects if the workflow was successful
public isSuccessful ( ) : boolean
리턴 boolean True if workflow succeeded

operations() 공개 메소드

Returns a list of WorkflowOperations for this workflow
public operations ( ) : WorkflowOperation[]
리턴 WorkflowOperation[]

serialize() 공개 메소드

Formats workflow object into an associative array for output
public serialize ( ) : array
리턴 array Associative array of data for output

wait() 공개 메소드

Waits on this workflow to finish
public wait ( ) : Workflow | void
리턴 Workflow | void

프로퍼티 상세

$owner 보호되어 있는 프로퍼티

protected mixed $owner
리턴 mixed