Composer API
Class

Composer\Downloader\PathDownloader

class PathDownloader extends FileDownloader implements VcsCapableDownloaderInterface

Download a package from a local path.

Constants

STRATEGY_SYMLINK

STRATEGY_MIRROR

Methods

__construct(IOInterface $io, Config $config, EventDispatcher $eventDispatcher = null, Cache $cache = null, RemoteFilesystem $rfs = null, Filesystem $filesystem = null)

Constructor.

from FileDownloader
string getInstallationSource()

Returns installation source (either source or dist).

from FileDownloader
download(PackageInterface $package, string $path, $output = true)

Downloads specific package into specific folder.

DownloaderInterface setOutputProgress(bool $outputProgress)

Sets whether to output download progress information or not

from FileDownloader
update(PackageInterface $initial, PackageInterface $target, string $path)

Updates specific package in specific folder from initial to target version.

from FileDownloader
remove(PackageInterface $package, string $path, $output = true)

Removes specific package from specific folder.

string|null getVcsReference(PackageInterface $package, string $path)

Gets the VCS Reference for the package at path

Details

in FileDownloader at line 55
public __construct(IOInterface $io, Config $config, EventDispatcher $eventDispatcher = null, Cache $cache = null, RemoteFilesystem $rfs = null, Filesystem $filesystem = null)

Constructor.

Parameters

IOInterface $io The IO instance
Config $config The config
EventDispatcher $eventDispatcher The event dispatcher
Cache $cache Optional cache instance
RemoteFilesystem $rfs The remote filesystem
Filesystem $filesystem The filesystem

in FileDownloader at line 72
public string getInstallationSource()

Returns installation source (either source or dist).

Return Value

string "source" or "dist"

at line 40
public download(PackageInterface $package, string $path, $output = true)

Downloads specific package into specific folder.

Parameters

PackageInterface $package package instance
string $path download path
$output

in FileDownloader at line 192
public DownloaderInterface setOutputProgress(bool $outputProgress)

Sets whether to output download progress information or not

Parameters

bool $outputProgress

Return Value

DownloaderInterface

in FileDownloader at line 210
public update(PackageInterface $initial, PackageInterface $target, string $path)

Updates specific package in specific folder from initial to target version.

Parameters

PackageInterface $initial initial package
PackageInterface $target updated package
string $path download path

at line 137
public remove(PackageInterface $package, string $path, $output = true)

Removes specific package from specific folder.

Parameters

PackageInterface $package package instance
string $path download path
$output

at line 160
public string|null getVcsReference(PackageInterface $package, string $path)

Gets the VCS Reference for the package at path

Parameters

PackageInterface $package package directory
string $path package directory

Return Value

string|null reference or null