PHP Class Rocketeer\Rocketeer

Author: Maxime Fabre ([email protected])
Inheritance: use trait Rocketeer\Traits\HasLocator
Show file Open project: anahkiasen/rocketeer

Protected Properties

Property Type Description
$local Global local mode.

Public Methods

Method Description
getApplicationName ( ) : string Get the name of the application to deploy.
getDetectedStage ( string $application = 'application', string | null $path = null ) : string | false Returns what stage Rocketeer thinks he's in.
getOption ( string $option ) : string | array | Closure Get an option from Rocketeer's config file.
isLocal ( ) : boolean
setLocal ( boolean $local )

Protected Methods

Method Description
getContextualOption ( string $option, string $type, string | array | null $original = null ) : string | array | Closure Get a contextual option.

Method Details

getApplicationName() public method

Get the name of the application to deploy.
public getApplicationName ( ) : string
return string

getContextualOption() protected method

Get a contextual option.
protected getContextualOption ( string $option, string $type, string | array | null $original = null ) : string | array | Closure
$option string
$type string [stage,connection]
$original string | array | null
return string | array | Closure

getDetectedStage() public static method

Returns what stage Rocketeer thinks he's in.
public static getDetectedStage ( string $application = 'application', string | null $path = null ) : string | false
$application string
$path string | null
return string | false

getOption() public method

Get an option from Rocketeer's config file.
public getOption ( string $option ) : string | array | Closure
$option string
return string | array | Closure

isLocal() public method

public isLocal ( ) : boolean
return boolean

setLocal() public method

public setLocal ( boolean $local )
$local boolean

Property Details

$local protected property

Global local mode.
protected $local