PHP Class Nwidart\Modules\Process\Installer

Afficher le fichier Open project: nwidart/laravel-modules Class Usage Examples

Protected Properties

Свойство Type Description
$console Illuminate\Console\Command The console command instance.
$name string The module name.
$path string The destionation path.
$repository Nwidart\Modules\Repository The module repository instance.
$timeout integer The process timeout.
$version string The version of module being installed.

Méthodes publiques

Méthode Description
__construct ( string $name, string $version = null, string $type = null, boolean $tree = false ) The constructor.
getBranch ( ) : string Get branch name.
getDestinationPath ( ) : string Get destination path.
getModuleName ( ) : string Get module name.
getPackageName ( ) : string Get composer package name.
getProcess ( ) : Process Get process instance.
getRepoUrl ( ) : string | null Get git repo url.
installViaComposer ( ) : Process Install the module via composer.
installViaGit ( ) : Process Install the module via git.
installViaSubtree ( ) : Process Install the module via git subtree.
run ( ) : Process Run the installation process.
setConsole ( Illuminate\Console\Command $console ) Set console command instance.
setPath ( string $path ) Set destination path.
setRepository ( Repository $repository ) Set the module repository instance.
setTimeout ( integer $timeout ) Set process timeout.

Method Details

__construct() public méthode

The constructor.
public __construct ( string $name, string $version = null, string $type = null, boolean $tree = false )
$name string
$version string
$type string
$tree boolean

getBranch() public méthode

Get branch name.
public getBranch ( ) : string
Résultat string

getDestinationPath() public méthode

Get destination path.
public getDestinationPath ( ) : string
Résultat string

getModuleName() public méthode

Get module name.
public getModuleName ( ) : string
Résultat string

getPackageName() public méthode

Get composer package name.
public getPackageName ( ) : string
Résultat string

getProcess() public méthode

Get process instance.
public getProcess ( ) : Process
Résultat Symfony\Component\Process\Process

getRepoUrl() public méthode

Get git repo url.
public getRepoUrl ( ) : string | null
Résultat string | null

installViaComposer() public méthode

Install the module via composer.
public installViaComposer ( ) : Process
Résultat Symfony\Component\Process\Process

installViaGit() public méthode

Install the module via git.
public installViaGit ( ) : Process
Résultat Symfony\Component\Process\Process

installViaSubtree() public méthode

Install the module via git subtree.
public installViaSubtree ( ) : Process
Résultat Symfony\Component\Process\Process

run() public méthode

Run the installation process.
public run ( ) : Process
Résultat Symfony\Component\Process\Process

setConsole() public méthode

Set console command instance.
public setConsole ( Illuminate\Console\Command $console )
$console Illuminate\Console\Command

setPath() public méthode

Set destination path.
public setPath ( string $path )
$path string

setRepository() public méthode

Set the module repository instance.
public setRepository ( Repository $repository )
$repository Nwidart\Modules\Repository

setTimeout() public méthode

Set process timeout.
public setTimeout ( integer $timeout )
$timeout integer

Property Details

$console protected_oe property

The console command instance.
protected Command,Illuminate\Console $console
Résultat Illuminate\Console\Command

$name protected_oe property

The module name.
protected string $name
Résultat string

$path protected_oe property

The destionation path.
protected string $path
Résultat string

$repository protected_oe property

The module repository instance.
protected Repository,Nwidart\Modules $repository
Résultat Nwidart\Modules\Repository

$timeout protected_oe property

The process timeout.
protected int $timeout
Résultat integer

$version protected_oe property

The version of module being installed.
protected string $version
Résultat string