yxorP Documentation

OxidInstaller extends BaseInstaller
in package

Table of Contents

VENDOR_PATTERN  = '/^modules\\/(?P<vendor>.+)\\/.+/'
$composer  : mixed
$io  : mixed
$locations  : mixed
$package  : mixed
__construct()  : mixed
Initializes base installer.
getInstallPath()  : string
getInstallPath
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.
prepareVendorDirectory()  : void
prepareVendorDirectory
templatePath()  : string
Replace vars in a path

Constants

VENDOR_PATTERN

public mixed VENDOR_PATTERN = '/^modules\\/(?P<vendor>.+)\\/.+/'

Properties

$locations

protected mixed $locations = array('module' => 'modules/{$name}/', 'theme' => 'application/views/{$name}/', 'out' => 'out/{$name}/')

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()

getInstallPath

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, 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

prepareVendorDirectory()

prepareVendorDirectory

protected prepareVendorDirectory(string $installPath) : void

Makes sure there is a vendormetadata.php file inside the vendor folder if there is a vendor folder.

Parameters
$installPath : string
Return values
void

templatePath()

Replace vars in a path

protected templatePath(string $path[, array<string, string> $vars = array() ]) : string
Parameters
$path : string
$vars : array<string, string> = array()
Return values
string

Search results