PHP Class ComponentInstaller\Process\Process

Processes are initialized, and then run during installation.
Inheritance: implements ComponentInstaller\Process\ProcessInterface
Mostra file Open project: robloach/component-installer Class Usage Examples

Protected Properties

Property Type Description
$componentDir string
$composer Composer\Composer
$config Composer\Config
$fs ComponentInstaller\Util\Filesystem
$installationManager Composer\Installer\InstallationManager The Composer installation manager to find Component vendor directories.
$io Composer\IO\IOInterface | Composer\IO\NullIO
$options array Any user provided options to configure this process.
$packages array

Public Methods

Method Description
__construct ( Composer\Composer $composer = null, Composer\IO\IOInterface $io = null )
getComponentDir ( ) Retrieves the component directory.
getComponentName ( string $prettyName, array $extra = [] ) : string Retrieves the component name for the component.
getVendorDir ( array $package ) : string Retrieves the given package's vendor directory, where it's installed.
init ( )
process ( )
setComponentDir ( string $dir ) : string Sets the component directory.

Method Details

__construct() public method

public __construct ( Composer\Composer $composer = null, Composer\IO\IOInterface $io = null )
$composer Composer\Composer
$io Composer\IO\IOInterface

getComponentDir() public method

Retrieves the component directory.
public getComponentDir ( )

getComponentName() public method

Retrieves the component name for the component.
public getComponentName ( string $prettyName, array $extra = [] ) : string
$prettyName string The Composer package name.
$extra array The extra config options sent from Composer.
return string The name of the component, without its vendor name.

getVendorDir() public method

Retrieves the given package's vendor directory, where it's installed.
public getVendorDir ( array $package ) : string
$package array The package to retrieve the vendor directory for.
return string

init() public method

public init ( )

process() public method

public process ( )

setComponentDir() public method

Sets the component directory.
public setComponentDir ( string $dir ) : string
$dir string
return string

Property Details

$componentDir protected_oe property

protected string $componentDir
return string

$composer protected_oe property

protected Composer,Composer $composer
return Composer\Composer

$config protected_oe property

protected Config,Composer $config
return Composer\Config

$fs protected_oe property

protected Filesystem,ComponentInstaller\Util $fs
return ComponentInstaller\Util\Filesystem

$installationManager protected_oe property

The Composer installation manager to find Component vendor directories.
protected InstallationManager,Composer\Installer $installationManager
return Composer\Installer\InstallationManager

$io protected_oe property

protected IOInterface,Composer\IO|NullIO,Composer\IO $io
return Composer\IO\IOInterface | Composer\IO\NullIO

$options protected_oe property

Any user provided options to configure this process.
protected array $options
return array

$packages protected_oe property

protected array $packages
return array