SilverStripeInstaller
extends BaseInstaller
in package
Table of Contents
- $composer : mixed
- $io : mixed
- $locations : mixed
- $package : mixed
- __construct() : mixed
- Initializes base installer.
- getInstallPath() : string
- Return the install path based on package type.
- getLocations() : array<string, string>
- Gets the installer's locations
- inflectPackageVars() : array<string, string>
- For an installer to override to modify the vars per installer.
- mapCustomInstallPaths() : string|false
- Search through a passed paths array for a custom install path.
- templatePath() : string
- Replace vars in a path
Properties
$composer
protected
mixed
$composer
$io
protected
mixed
$io
$locations
protected
mixed
$locations
= array('module' => '{$name}/', 'theme' => 'themes/{$name}/')
$package
protected
mixed
$package
Methods
__construct()
Initializes base installer.
public
__construct([PackageInterface $package = null ][, Composer $composer = null ][, IOInterface $io = null ]) : mixed
Parameters
- $package : PackageInterface = null
- $composer : Composer = null
- $io : IOInterface = null
Return values
mixed —getInstallPath()
Return the install path based on package type.
public
getInstallPath(PackageInterface $package[, string $frameworkType = '' ]) : string
Relies on built-in BaseInstaller behaviour with one exception: silverstripe/framework must be installed to 'sapphire' and not 'framework' if the version is <3.0.0
Parameters
- $package : PackageInterface
- $frameworkType : string = ''
Return values
string —getLocations()
Gets the installer's locations
public
getLocations() : array<string, string>
Return values
array<string, string> —map of package types => install path
inflectPackageVars()
For an installer to override to modify the vars per installer.
public
inflectPackageVars(array<string, string> $vars) : array<string, string>
Parameters
- $vars : array<string, string>
-
This will normally receive array{name: string, vendor: string, type: string}
Return values
array<string, string> —mapCustomInstallPaths()
Search through a passed paths array for a custom install path.
protected
mapCustomInstallPaths(array<string|int, mixed> $paths, string $name, string $type[, string $vendor = NULL ]) : string|false
Parameters
- $paths : array<string|int, mixed>
- $name : string
- $type : string
- $vendor : string = NULL
-
= NULL
Return values
string|false —templatePath()
Replace vars in a path
protected
templatePath(string $path[, array<string, string> $vars = array() ]) : string
Parameters
- $path : string
- $vars : array<string, string> = array()