PHP Class LEtudiant\Composer\Installer\Config\SharedPackageInstallerConfig

See also: https://github.com/Letudiant/composer-shared-package-plugin/blob/master/docs/all-available-configurations.md
Author: Sylvain Lorinet ([email protected])
Show file Open project: letudiant/composer-shared-package-plugin Class Usage Examples

Protected Properties

Property Type Description
$isSymlinkEnabled boolean
$originalVendorDir string
$packageList array
$symlinkBasePath string | null
$symlinkDir string
$vendorDir string

Public Methods

Method Description
__construct ( string $originalRelativeVendorDir, string $originalAbsoluteVendorDir, array | null $extraConfigs )
getOriginalVendorDir ( boolean $endingSlash = false ) : string
getPackageList ( ) : array
getSymlinkBasePath ( ) : string | null
getSymlinkDir ( ) : string
getVendorDir ( ) : string
isSymlinkEnabled ( ) : boolean
setPackageList ( array $extraConfigs )

Protected Methods

Method Description
setIsSymlinkEnabled ( array $extraConfigs ) The symlink directory creation process can be disabled.
setSymlinkBasePath ( array $extraConfigs ) Allow to override symlinks base path.
setSymlinkDirectory ( string $baseDir, array $extraConfigs )
setVendorDir ( string $baseDir, array $extraConfigs )

Method Details

__construct() public method

public __construct ( string $originalRelativeVendorDir, string $originalAbsoluteVendorDir, array | null $extraConfigs )
$originalRelativeVendorDir string
$originalAbsoluteVendorDir string
$extraConfigs array | null

getOriginalVendorDir() public method

public getOriginalVendorDir ( boolean $endingSlash = false ) : string
$endingSlash boolean
return string

getPackageList() public method

public getPackageList ( ) : array
return array

getSymlinkBasePath() public method

public getSymlinkBasePath ( ) : string | null
return string | null

getSymlinkDir() public method

public getSymlinkDir ( ) : string
return string

getVendorDir() public method

public getVendorDir ( ) : string
return string

isSymlinkEnabled() public method

public isSymlinkEnabled ( ) : boolean
return boolean

setIsSymlinkEnabled() protected method

This may mean that you work directly with the sources directory so the symlink directory is useless.
protected setIsSymlinkEnabled ( array $extraConfigs )
$extraConfigs array

setPackageList() public method

public setPackageList ( array $extraConfigs )
$extraConfigs array

setSymlinkBasePath() protected method

This is useful for a Virtual Machine environment, where directories can be different on the host machine and the guest machine.
protected setSymlinkBasePath ( array $extraConfigs )
$extraConfigs array

setSymlinkDirectory() protected method

protected setSymlinkDirectory ( string $baseDir, array $extraConfigs )
$baseDir string
$extraConfigs array

setVendorDir() protected method

protected setVendorDir ( string $baseDir, array $extraConfigs )
$baseDir string
$extraConfigs array

Property Details

$isSymlinkEnabled protected property

protected bool $isSymlinkEnabled
return boolean

$originalVendorDir protected property

protected string $originalVendorDir
return string

$packageList protected property

protected array $packageList
return array

$symlinkBasePath protected property

protected string|null $symlinkBasePath
return string | null

$symlinkDir protected property

protected string $symlinkDir
return string

$vendorDir protected property

protected string $vendorDir
return string