yxorP Documentation

MicroweberInstaller 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>
Format package name.
inflectCoreVars()  : mixed
inflectElementVars()  : mixed
inflectModulesVars()  : mixed
inflectModuleVars()  : mixed
inflectSkinVars()  : mixed
inflectTemplatesVars()  : mixed
inflectTemplateVars()  : mixed
mapCustomInstallPaths()  : string|false
Search through a passed paths array for a custom install path.
templatePath()  : string
Replace vars in a path

Properties

$locations

protected mixed $locations = array('module' => 'userfiles/modules/{$install_item_dir}/', 'module-skin' => 'userfiles/modules/{$install_item_dir}/templates/', 'template' => 'userfiles/templates/{$install_item_dir}/', 'element' => 'userfiles/elements/{$install_item_dir}/', 'vendor' => 'vendor/{$install_item_dir}/', 'components' => 'components/{$install_item_dir}/')

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, string>
Return values
array<string, string>

map of package types => install path

inflectPackageVars()

Format package name.

public inflectPackageVars(mixed $vars) : array<string, string>

For package type microweber-module, cut off a trailing '-module' if present

For package type microweber-template, cut off a trailing '-template' if present.

Parameters
$vars : mixed

This will normally receive array{name: string, vendor: string, type: string}

Return values
array<string, string>

inflectCoreVars()

protected inflectCoreVars(mixed $vars) : mixed
Parameters
$vars : mixed
Return values
mixed

inflectElementVars()

protected inflectElementVars(mixed $vars) : mixed
Parameters
$vars : mixed
Return values
mixed

inflectModulesVars()

protected inflectModulesVars(mixed $vars) : mixed
Parameters
$vars : mixed
Return values
mixed

inflectModuleVars()

protected inflectModuleVars(mixed $vars) : mixed
Parameters
$vars : mixed
Return values
mixed

inflectSkinVars()

protected inflectSkinVars(mixed $vars) : mixed
Parameters
$vars : mixed
Return values
mixed

inflectTemplatesVars()

protected inflectTemplatesVars(mixed $vars) : mixed
Parameters
$vars : mixed
Return values
mixed

inflectTemplateVars()

protected inflectTemplateVars(mixed $vars) : mixed
Parameters
$vars : mixed
Return values
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|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()
Return values
string

Search results