PHP Class Airship\Engine\Continuum\Installers\Cabin

This allows a new Cabin to be installed.
Inheritance: extends Airship\Engine\Continuum\Installer, use trait Airship\Engine\Bolt\Common
Show file Open project: paragonie/airship

Protected Properties

Property Type Description
$ext string
$type string

Public Methods

Method Description
clearCache ( ) : boolean Clear the cache files related to Cabins.
install ( InstallFile $fileInfo ) : boolean Cabin install process.

Protected Methods

Method Description
configure ( string $nameSpace, array $metadata = [] ) : boolean Create the default configuration
createEmptyFiles ( string $nameSpace ) : boolean Create empty files (motifs.json, etc.)
createSymlinks ( string $nameSpace ) : boolean Create the initial symlinks for this Cabin
defaultCabinConfig ( string $nameSpace ) : boolean Create the default configuration
updateCabinsRegistry ( string $nameSpace, array $metadata ) : boolean Add the new cabin to config/cabins.json

Method Details

clearCache() public method

Clear the cache files related to Cabins.
public clearCache ( ) : boolean
return boolean

configure() protected method

Create the default configuration
protected configure ( string $nameSpace, array $metadata = [] ) : boolean
$nameSpace string
$metadata array
return boolean

createEmptyFiles() protected method

Create empty files (motifs.json, etc.)
protected createEmptyFiles ( string $nameSpace ) : boolean
$nameSpace string
return boolean

defaultCabinConfig() protected method

Create the default configuration
protected defaultCabinConfig ( string $nameSpace ) : boolean
$nameSpace string
return boolean

install() public method

1. Extract files to proper directory. 2. Run the update triggers (install hooks and incremental upgrades) 3. Create/update relevant configuration files. 4. Create symbolic links. 5. Clear the cache files.
public install ( InstallFile $fileInfo ) : boolean
$fileInfo InstallFile
return boolean

updateCabinsRegistry() protected method

Add the new cabin to config/cabins.json
protected updateCabinsRegistry ( string $nameSpace, array $metadata ) : boolean
$nameSpace string
$metadata array
return boolean

Property Details

$ext protected property

protected string $ext
return string

$type protected property

protected string $type
return string