Installer
extends LibraryInstaller
in package
Tags
Table of Contents
Constants
- EXTENSION_FILE = 'yiisoft/extensions.php'
- EXTRA_BOOTSTRAP = 'bootstrap'
Methods
- copyFiles() : mixed
- Copy files to specified locations.
- generateCookieValidationKey() : mixed
- Generates a cookie validation key for every app config listed in "config" in extra section.
- install() : mixed
- postCreateProject() : mixed
- Special method to run tasks defined in `[extra][yii\composer\Installer::postCreateProject]` key in `composer.json`
- postInstall() : mixed
- Special method to run tasks defined in `[extra][yii\composer\Installer::postInstall]` key in `composer.json`
- setPermission() : mixed
- Sets the correct permission for the files and directories listed in the extra section.
- supports() : mixed
- uninstall() : mixed
- update() : mixed
- addPackage() : mixed
- generateDefaultAlias() : mixed
- generateRandomString() : mixed
- linkBaseYiiFiles() : mixed
- loadExtensions() : mixed
- removeBaseYiiFiles() : mixed
- removePackage() : mixed
- runCommands() : mixed
- Special method to run tasks defined in `[extra][$extraKey]` key in `composer.json`
- saveExtensions() : mixed
Constants
EXTENSION_FILE
public
mixed
EXTENSION_FILE
= 'yiisoft/extensions.php'
EXTRA_BOOTSTRAP
public
mixed
EXTRA_BOOTSTRAP
= 'bootstrap'
Methods
copyFiles()
Copy files to specified locations.
public
static copyFiles(array<string|int, mixed> $paths) : mixed
Parameters
- $paths : array<string|int, mixed>
-
The source files paths (keys) and the corresponding target locations for copied files (values). Location can be specified as an array - first element is target location, second defines whether file can be overwritten (by default method don't overwrite existing files).
Tags
generateCookieValidationKey()
Generates a cookie validation key for every app config listed in "config" in extra section.
public
static generateCookieValidationKey() : mixed
You can provide one or multiple parameters as the configuration files which need to have validation key inserted.
install()
public
install(InstalledRepositoryInterface $repo, PackageInterface $package) : mixed
Parameters
- $repo : InstalledRepositoryInterface
- $package : PackageInterface
Tags
postCreateProject()
Special method to run tasks defined in `[extra][yii\composer\Installer::postCreateProject]` key in `composer.json`
public
static postCreateProject(Event $event) : mixed
Parameters
- $event : Event
postInstall()
Special method to run tasks defined in `[extra][yii\composer\Installer::postInstall]` key in `composer.json`
public
static postInstall(Event $event) : mixed
Parameters
- $event : Event
Tags
setPermission()
Sets the correct permission for the files and directories listed in the extra section.
public
static setPermission(array<string|int, mixed> $paths) : mixed
Parameters
- $paths : array<string|int, mixed>
-
the paths (keys) and the corresponding permission octal strings (values)
supports()
public
supports(mixed $packageType) : mixed
Parameters
- $packageType : mixed
Tags
uninstall()
public
uninstall(InstalledRepositoryInterface $repo, PackageInterface $package) : mixed
Parameters
- $repo : InstalledRepositoryInterface
- $package : PackageInterface
Tags
update()
public
update(InstalledRepositoryInterface $repo, PackageInterface $initial, PackageInterface $target) : mixed
Parameters
- $repo : InstalledRepositoryInterface
- $initial : PackageInterface
- $target : PackageInterface
Tags
addPackage()
protected
addPackage(PackageInterface $package) : mixed
Parameters
- $package : PackageInterface
generateDefaultAlias()
protected
generateDefaultAlias(PackageInterface $package) : mixed
Parameters
- $package : PackageInterface
generateRandomString()
protected
static generateRandomString() : mixed
linkBaseYiiFiles()
protected
linkBaseYiiFiles() : mixed
loadExtensions()
protected
loadExtensions() : mixed
removeBaseYiiFiles()
protected
removeBaseYiiFiles() : mixed
removePackage()
protected
removePackage(PackageInterface $package) : mixed
Parameters
- $package : PackageInterface
runCommands()
Special method to run tasks defined in `[extra][$extraKey]` key in `composer.json`
protected
static runCommands(Event $event, string $extraKey) : mixed
Parameters
- $event : Event
- $extraKey : string
Tags
saveExtensions()
protected
saveExtensions(array<string|int, mixed> $extensions) : mixed
Parameters
- $extensions : array<string|int, mixed>