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
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$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