InstallerInterface
in
Interface for the package installation manager.
Tags
Table of Contents
- getInstallPath() : string
- Returns the installation path of a package
- install() : mixed
- Installs specific package.
- isInstalled() : bool
- Checks that provided package is installed.
- supports() : bool
- Decides if the installer supports the given type
- uninstall() : mixed
- Uninstalls specific package.
- update() : mixed
- Updates specific package.
Methods
getInstallPath()
Returns the installation path of a package
public
getInstallPath(PackageInterface $package) : string
Parameters
- $package : PackageInterface
Return values
string —path
install()
Installs specific package.
public
install(InstalledRepositoryInterface $repo, PackageInterface $package) : mixed
Parameters
- $repo : InstalledRepositoryInterface
-
repository in which to check
- $package : PackageInterface
-
package instance
Return values
mixed —isInstalled()
Checks that provided package is installed.
public
isInstalled(InstalledRepositoryInterface $repo, PackageInterface $package) : bool
Parameters
- $repo : InstalledRepositoryInterface
-
repository in which to check
- $package : PackageInterface
-
package instance
Return values
bool —supports()
Decides if the installer supports the given type
public
supports(string $packageType) : bool
Parameters
- $packageType : string
Return values
bool —uninstall()
Uninstalls specific package.
public
uninstall(InstalledRepositoryInterface $repo, PackageInterface $package) : mixed
Parameters
- $repo : InstalledRepositoryInterface
-
repository in which to check
- $package : PackageInterface
-
package instance
Return values
mixed —update()
Updates specific package.
public
update(InstalledRepositoryInterface $repo, PackageInterface $initial, PackageInterface $target) : mixed
Parameters
- $repo : InstalledRepositoryInterface
-
repository in which to check
- $initial : PackageInterface
-
already installed package version
- $target : PackageInterface
-
updated version