PHP Class Platformsh\Cli\Util\ActivityUtil

Show file Open project: commerceguys/platform-cli Class Usage Examples

Protected Properties

Property	Type	Description
$stateNames

Public Methods

Method	Description
formatState ( string $state ) : string	Format a state name.
waitAndLog ( Platformsh\Client\Model\Activity $activity, Symfony\Component\Console\Output\OutputInterface $output, string $success = null, string $failure = null ) : boolean	Wait for a single activity to complete, and display the log continuously.
waitMultiple ( array $activities, Symfony\Component\Console\Output\OutputInterface $output, Platformsh\Client\Model\Project $project ) : boolean	Wait for multiple activities to complete.

Method Details

formatState() public static method

Format a state name.

public static formatState ( string $state ) : string
$state	string
return	string

waitAndLog() public static method

Wait for a single activity to complete, and display the log continuously.

public static waitAndLog ( Platformsh\Client\Model\Activity $activity, Symfony\Component\Console\Output\OutputInterface $output, string $success = null, string $failure = null ) : boolean
$activity	Platformsh\Client\Model\Activity
$output	Symfony\Component\Console\Output\OutputInterface
$success	string
$failure	string
return	boolean	True if the activity succeeded, false otherwise.

waitMultiple() public static method

A progress bar tracks the state of each activity. The activity log is only displayed at the end, if an activity failed.

public static waitMultiple ( array $activities, Symfony\Component\Console\Output\OutputInterface $output, Platformsh\Client\Model\Project $project ) : boolean
$activities	array
$output	Symfony\Component\Console\Output\OutputInterface
$project	Platformsh\Client\Model\Project
return	boolean	True if all activities succeed, false otherwise.

Property Details

$stateNames protected static property

protected static $stateNames