\Composer\DownloaderPerforceDownloader

Summary

Methods

Properties

Constants

__construct()
getInstallationSource()
download()
update()
remove()
setOutputProgress()
getVcsReference()
doDownload()
doUpdate()
initPerforce()
getLocalChanges()
setPerforce()

No public properties found

No constants found

cleanChanges()
reapplyChanges()
getCommitLogs()
hasMetadataRepository()

$io
$config
$process
$filesystem
$perforce

N/A

getLabelFromSourceReference()
getRepoConfig()

No private properties found

N/A

File: vendor/composer/composer/src/Composer/Downloader/PerforceDownloader.php
Package: Default
Class hierarchy: \Composer\Downloader\VcsDownloader

\Composer\Downloader\PerforceDownloader

Properties

$io

$io : \Composer\IO\IOInterface

Type

\Composer\IO\IOInterface

$config

$config : \Composer\Config

Type

\Composer\Config

$process

$process : \Composer\Util\ProcessExecutor

Type

\Composer\Util\ProcessExecutor

$filesystem

$filesystem : \Composer\Util\Filesystem

Type

\Composer\Util\Filesystem

$perforce

$perforce : \Composer\Util\Perforce

Type

\Composer\Util\Perforce

Methods

__construct()

__construct(\Composer\IO\IOInterface  $io, \Composer\Config  $config, \Composer\Util\ProcessExecutor  $process = null, \Composer\Util\Filesystem  $fs = null)

Parameters

\Composer\IO\IOInterface	$io
\Composer\Config	$config
\Composer\Util\ProcessExecutor	$process
\Composer\Util\Filesystem	$fs

getInstallationSource()

getInstallationSource() : string

Returns installation source (either source or dist).

Returns

string —

"source" or "dist"

download()

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

Downloads specific package into specific folder.

Parameters

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

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)

Removes specific package from specific folder.

Parameters

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

setOutputProgress()

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

Download progress information is not available for all VCS downloaders.

Parameters

boolean

$outputProgress

Returns

\Composer\Downloader\DownloaderInterface

getVcsReference()

getVcsReference(\Composer\Package\PackageInterface  $package, string  $path) : string|null

Gets the VCS Reference for the package at path

Parameters

\Composer\Package\PackageInterface	$package	package directory
string	$path	package directory

Returns

string|null —

reference or null

doDownload()

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

Downloads specific package into specific folder.

Parameters

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

doUpdate()

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

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
string	$url	package url

initPerforce()

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

Parameters

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

getLocalChanges()

getLocalChanges(\Composer\Package\PackageInterface  $package,   $path)

{@inheritDoc}

Parameters

\Composer\Package\PackageInterface	$package
	$path

setPerforce()

setPerforce(  $perforce)

Parameters

$perforce

cleanChanges()

cleanChanges(\Composer\Package\PackageInterface  $package, string  $path, boolean  $update)

Prompt the user to check if changes should be stashed/removed or the operation aborted

Parameters

\Composer\Package\PackageInterface	$package
string	$path
boolean	$update	if true (update) the changes can be stashed and reapplied after an update, if false (remove) the changes should be assumed to be lost if the operation is not aborted

Throws

\RuntimeException: in case the operation must be aborted

reapplyChanges()

reapplyChanges(string  $path)

Guarantee that no changes have been made to the local copy

Parameters

string

$path

Throws

\RuntimeException: in case the operation must be aborted or the patch does not apply cleanly

getCommitLogs()

getCommitLogs(string  $fromReference, string  $toReference, string  $path) : string

Fetches the commit logs between two commits

Parameters

string	$fromReference	the source reference
string	$toReference	the target reference
string	$path	the package path

Returns

string

hasMetadataRepository()

hasMetadataRepository(string  $path) : boolean

Checks if VCS metadata repository has been initialized repository example: .git|.svn|.hg

Parameters

string

$path

Returns

boolean

getLabelFromSourceReference()

getLabelFromSourceReference(  $ref)

Parameters

$ref

getRepoConfig()

getRepoConfig(\Composer\Repository\VcsRepository  $repository)

Parameters

\Composer\Repository\VcsRepository

$repository