WHMCSInstaller
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|int, mixed>
- Gets the installer's locations
- inflectPackageVars() : array<string|int, mixed>
- For an installer to override to modify the vars per installer.
- mapCustomInstallPaths() : string
- 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('addons' => 'modules/addons/{$vendor}_{$name}/', 'fraud' => 'modules/fraud/{$vendor}_{$name}/', 'gateways' => 'modules/gateways/{$vendor}_{$name}/', 'notifications' => 'modules/notifications/{$vendor}_{$name}/', 'registrars' => 'modules/registrars/{$vendor}_{$name}/', 'reports' => 'modules/reports/{$vendor}_{$name}/', 'security' => 'modules/security/{$vendor}_{$name}/', 'servers' => 'modules/servers/{$vendor}_{$name}/', 'social' => 'modules/social/{$vendor}_{$name}/', 'support' => 'modules/support/{$vendor}_{$name}/', 'templates' => 'templates/{$vendor}_{$name}/', 'includes' => 'includes/{$vendor}_{$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
Parameters
- $package : PackageInterface
- $frameworkType : string = ''
Return values
string —getLocations()
Gets the installer's locations
public
getLocations() : array<string|int, mixed>
Return values
array<string|int, mixed> —inflectPackageVars()
For an installer to override to modify the vars per installer.
public
inflectPackageVars(array<string|int, mixed> $vars) : array<string|int, mixed>
Parameters
- $vars : array<string|int, mixed>
Return values
array<string|int, mixed> —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
Parameters
- $paths : array<string|int, mixed>
- $name : string
- $type : string
- $vendor : string = NULL
-
= NULL
Return values
string —templatePath()
Replace vars in a path
protected
templatePath(string $path[, array<string|int, mixed> $vars = array() ]) : string
Parameters
- $path : string
- $vars : array<string|int, mixed> = array()