PHP Interface Platformsh\Cli\Local\Toolstack\ToolstackInterface

Afficher le fichier Open project: commerceguys/platform-cli

Méthodes publiques

Méthode Description
addIgnoredFiles ( array $ignoredFiles ) Add to the list of files (in the app root) that should not be copied.
build ( ) Build this application. Acquire dependencies, plugins, libraries, and submodules.
canArchive ( ) : boolean Find whether the build may be archived.
detect ( string $appRoot ) : boolean Detect if the files in a given directory belong to this toolstack.
getAppDir ( ) : string Get the application root after build.
getKey ( ) : string | false Get the configuration key for the toolstack.
getWebRoot ( ) : string Get the document root after build.
install ( ) Move files into place. This could happen straight after the build, or after an old build archive has been extracted.
prepare ( string $buildDir, LocalApplication $app, CliConfig $config, array $settings = [] ) Prepare this application to be built.
setBuildDir ( string $buildDir ) Set the build directory.
setOutput ( Symfony\Component\Console\Output\OutputInterface $output ) Set the output stream for the toolstack.

Method Details

addIgnoredFiles() public méthode

Add to the list of files (in the app root) that should not be copied.
public addIgnoredFiles ( array $ignoredFiles )
$ignoredFiles array

build() public méthode

Build this application. Acquire dependencies, plugins, libraries, and submodules.
public build ( )

canArchive() public méthode

Find whether the build may be archived.
public canArchive ( ) : boolean
Résultat boolean

detect() public méthode

Detect if the files in a given directory belong to this toolstack.
public detect ( string $appRoot ) : boolean
$appRoot string The absolute path to the application folder
Résultat boolean Whether this toolstack is a valid choice or not

getAppDir() public méthode

Get the application root after build.
public getAppDir ( ) : string
Résultat string

getKey() public méthode

Get the configuration key for the toolstack.
public getKey ( ) : string | false
Résultat string | false

getWebRoot() public méthode

Get the document root after build.
public getWebRoot ( ) : string
Résultat string

install() public méthode

Move files into place. This could happen straight after the build, or after an old build archive has been extracted.
public install ( )

prepare() public méthode

This function should be isometric and not affect the file system.
public prepare ( string $buildDir, LocalApplication $app, CliConfig $config, array $settings = [] )
$buildDir string The directory in which the app should be built.
$app Platformsh\Cli\Local\LocalApplication The app to build.
$config Platformsh\Cli\CliConfig CLI configuration.
$settings array Additional settings for the build. Possible settings include: - clone (bool, default false) Clone the repository to the build directory before building, where possible. - copy (bool, default false) Copy files instead of symlinking them, where possible. - abslinks (bool, default false) Use absolute paths in symlinks. - no-cache (bool, default false) Disable the package cache (if relevant and if the package manager supports this). - sourceDir (string) The source directory that contains the app(s). - multiApp (bool, default false) Whether there is more than 1 app in the source directory.

setBuildDir() public méthode

Set the build directory.
public setBuildDir ( string $buildDir )
$buildDir string

setOutput() public méthode

Set the output stream for the toolstack.
public setOutput ( Symfony\Component\Console\Output\OutputInterface $output )
$output Symfony\Component\Console\Output\OutputInterface