\Composer\DownloaderZipDownloader

Base downloader for archives

Summary

Methods

Properties

Constants

download()
extract()
__construct()
getInstallationSource()
setOutputProgress()
update()
remove()
getLocalChanges()

No public properties found

No constants found

getFileName()
doDownload()
clearLastCacheWrite()
processUrl()
extractWithSystemUnzip()
extractWithZipArchive()
getErrorMessage()

$io
$config
$rfs
$filesystem
$cache
$outputProgress
$hasSystemUnzip
$process

N/A

getFolderContent()
getCacheKey()

$lastCacheWrites
$eventDispatcher
$hasZipArchive
$isWindows
$zipArchiveObject

N/A

File: vendor/composer/composer/src/Composer/Downloader/ZipDownloader.php
Package: Default
Class hierarchy: \Composer\Downloader\FileDownloader

\Composer\Downloader\ArchiveDownloader

\Composer\Downloader\ZipDownloader

Properties

$io

$io :

Type

$config

$config :

Type

$rfs

$rfs :

Type

$filesystem

$filesystem :

Type

$cache

$cache :

Type

$outputProgress

$outputProgress :

Type

$hasSystemUnzip

$hasSystemUnzip :

Type

$process

$process :

Type

$lastCacheWrites

$lastCacheWrites :

Type

$eventDispatcher

$eventDispatcher :

Type

$hasZipArchive

$hasZipArchive :

Type

$isWindows

$isWindows :

Type

$zipArchiveObject

$zipArchiveObject :

Type

Methods

download()

download(\Composer\Package\PackageInterface  $package, string  $path,   $output = true)

Downloads specific package into specific folder.

Parameters

\Composer\Package\PackageInterface	$package	package instance
string	$path	download path
	$output

extract()

extract(string  $file, string  $path)

extract $file to $path

Parameters

string	$file	File to extract
string	$path	Path where to extract file

__construct()

__construct(\Composer\IO\IOInterface  $io, \Composer\Config  $config, \Composer\EventDispatcher\EventDispatcher  $eventDispatcher = null, \Composer\Cache  $cache = null, \Composer\Util\ProcessExecutor  $process = null, \Composer\Util\RemoteFilesystem  $rfs = null)

Parameters

\Composer\IO\IOInterface	$io
\Composer\Config	$config
\Composer\EventDispatcher\EventDispatcher	$eventDispatcher
\Composer\Cache	$cache
\Composer\Util\ProcessExecutor	$process
\Composer\Util\RemoteFilesystem	$rfs

getInstallationSource()

getInstallationSource() : string

Returns installation source (either source or dist).

Returns

string —

"source" or "dist"

setOutputProgress()

setOutputProgress(boolean  $outputProgress) : \Composer\Downloader\DownloaderInterface

Sets whether to output download progress information or not

Parameters

boolean

$outputProgress

Returns

\Composer\Downloader\DownloaderInterface

update()

update(\Composer\Package\PackageInterface  $initial, \Composer\Package\PackageInterface  $target, string  $path)

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

Parameters

\Composer\Package\PackageInterface	$initial	initial package
\Composer\Package\PackageInterface	$target	updated package
string	$path	download path

remove()

remove(\Composer\Package\PackageInterface  $package, string  $path,   $output = true)

Removes specific package from specific folder.

Parameters

\Composer\Package\PackageInterface	$package	package instance
string	$path	download path
	$output

getLocalChanges()

getLocalChanges(\Composer\Package\PackageInterface  $package,   $targetDir) : string|null

Checks for changes to the local copy

Parameters

\Composer\Package\PackageInterface	$package	package instance
	$targetDir

Throws

\RuntimeException

Returns

string|null —

changes or null

getFileName()

getFileName(\Composer\Package\PackageInterface  $package, string  $path) : string

Gets file name for specific package

Parameters

\Composer\Package\PackageInterface	$package	package instance
string	$path	download path

Returns

string —

file name

doDownload()

doDownload(\Composer\Package\PackageInterface  $package,   $path,   $url)

Parameters

\Composer\Package\PackageInterface	$package
	$path
	$url

clearLastCacheWrite()

clearLastCacheWrite(\Composer\Package\PackageInterface  $package)

Parameters

\Composer\Package\PackageInterface

$package

processUrl()

processUrl(\Composer\Package\PackageInterface  $package, string  $url) : string

Process the download url

Parameters

\Composer\Package\PackageInterface	$package	package the url is coming from
string	$url	download url

Throws

\RuntimeException: If any problem with the url

Returns

string —

url

extractWithSystemUnzip()

extractWithSystemUnzip(string  $file, string  $path, boolean  $isLastChance) : boolean

extract $file to $path with "unzip" command

Parameters

string	$file	File to extract
string	$path	Path where to extract file
boolean	$isLastChance	If true it is called as a fallback and should throw an exception

Returns

boolean —

Success status

extractWithZipArchive()

extractWithZipArchive(string  $file, string  $path, boolean  $isLastChance) : boolean

extract $file to $path with ZipArchive

Parameters

string	$file	File to extract
string	$path	Path where to extract file
boolean	$isLastChance	If true it is called as a fallback and should throw an exception

Returns

boolean —

Success status

getErrorMessage()

getErrorMessage(integer  $retval, string  $file) : string

Give a meaningful error message to the user.

Parameters

integer	$retval
string	$file

Returns

string

getFolderContent()

getFolderContent(string  $dir) : array<mixed,\SplFileInfo>

Returns the folder content, excluding dotfiles

Parameters

string

$dir

Returns

array<mixed,\SplFileInfo>

getCacheKey()

getCacheKey(\Composer\Package\PackageInterface  $package,   $processedUrl)

Parameters

\Composer\Package\PackageInterface	$package
	$processedUrl