HgDriver
extends VcsDriver
in package
A driver implementation for driver with authentication interaction.
Tags
Table of Contents
- $branches : mixed
- $cache : Cache
- $config : Config
- $infoCache : array<string|int, mixed>
- $io : IOInterface
- $originUrl : string
- $process : ProcessExecutor
- $remoteFilesystem : RemoteFilesystem
- $repoConfig : array<string|int, mixed>
- $repoDir : mixed
- $rootIdentifier : mixed
- $tags : mixed
- $url : string
- __construct() : mixed
- Constructor.
- cleanup() : mixed
- Performs any cleanup necessary as the driver is not longer needed
- getBranches() : mixed
- {@inheritDoc}
- getChangeDate() : mixed
- {@inheritdoc}
- getComposerInformation() : array<string|int, mixed>
- Return the composer.json file information
- getDist() : mixed
- {@inheritDoc}
- getFileContent() : mixed
- {@inheritdoc}
- getRootIdentifier() : mixed
- {@inheritDoc}
- getSource() : mixed
- {@inheritDoc}
- getTags() : mixed
- {@inheritDoc}
- getUrl() : mixed
- {@inheritDoc}
- hasComposerFile() : bool
- Return true if the repository has a composer file for a given identifier, false otherwise.
- initialize() : mixed
- {@inheritDoc}
- supports() : mixed
- {@inheritDoc}
- getBaseComposerInformation() : mixed
- getContents() : mixed
- Get the remote content.
- getScheme() : string
- Get the https or http protocol depending on SSL support.
- shouldCache() : bool
- Returns whether or not the given $identifier should be cached or not.
Properties
$branches
protected
mixed
$branches
$cache
protected
Cache
$cache
$config
protected
Config
$config
$infoCache
protected
array<string|int, mixed>
$infoCache
= array()
$io
protected
IOInterface
$io
$originUrl
protected
string
$originUrl
$process
protected
ProcessExecutor
$process
$remoteFilesystem
protected
RemoteFilesystem
$remoteFilesystem
$repoConfig
protected
array<string|int, mixed>
$repoConfig
$repoDir
protected
mixed
$repoDir
$rootIdentifier
protected
mixed
$rootIdentifier
$tags
protected
mixed
$tags
$url
protected
string
$url
Methods
__construct()
Constructor.
public
final __construct(array<string|int, mixed> $repoConfig, IOInterface $io, Config $config[, ProcessExecutor $process = null ][, RemoteFilesystem $remoteFilesystem = null ]) : mixed
Parameters
- $repoConfig : array<string|int, mixed>
-
The repository configuration
- $io : IOInterface
-
The IO instance
- $config : Config
-
The composer configuration
- $process : ProcessExecutor = null
-
Process instance, injectable for mocking
- $remoteFilesystem : RemoteFilesystem = null
-
Remote Filesystem, injectable for mocking
Return values
mixed —cleanup()
Performs any cleanup necessary as the driver is not longer needed
public
cleanup() : mixed
Return values
mixed —getBranches()
{@inheritDoc}
public
getBranches() : mixed
Return values
mixed —getChangeDate()
{@inheritdoc}
public
getChangeDate(mixed $identifier) : mixed
Parameters
- $identifier : mixed
Return values
mixed —getComposerInformation()
Return the composer.json file information
public
getComposerInformation(mixed $identifier) : array<string|int, mixed>
Parameters
- $identifier : mixed
-
Any identifier to a specific branch/tag/commit
Return values
array<string|int, mixed> —containing all infos from the composer.json file
getDist()
{@inheritDoc}
public
getDist(mixed $identifier) : mixed
Parameters
- $identifier : mixed
Return values
mixed —getFileContent()
{@inheritdoc}
public
getFileContent(mixed $file, mixed $identifier) : mixed
Parameters
- $file : mixed
- $identifier : mixed
Return values
mixed —getRootIdentifier()
{@inheritDoc}
public
getRootIdentifier() : mixed
Return values
mixed —getSource()
{@inheritDoc}
public
getSource(mixed $identifier) : mixed
Parameters
- $identifier : mixed
Return values
mixed —getTags()
{@inheritDoc}
public
getTags() : mixed
Return values
mixed —getUrl()
{@inheritDoc}
public
getUrl() : mixed
Return values
mixed —hasComposerFile()
Return true if the repository has a composer file for a given identifier, false otherwise.
public
hasComposerFile(mixed $identifier) : bool
Parameters
- $identifier : mixed
-
Any identifier to a specific branch/tag/commit
Return values
bool —Whether the repository has a composer file for a given identifier.
initialize()
{@inheritDoc}
public
initialize() : mixed
Return values
mixed —supports()
{@inheritDoc}
public
static supports(IOInterface $io, Config $config, mixed $url[, mixed $deep = false ]) : mixed
Parameters
- $io : IOInterface
- $config : Config
- $url : mixed
- $deep : mixed = false
Return values
mixed —getBaseComposerInformation()
protected
getBaseComposerInformation(mixed $identifier) : mixed
Parameters
- $identifier : mixed
Return values
mixed —getContents()
Get the remote content.
protected
getContents(string $url) : mixed
Parameters
- $url : string
-
The URL of content
Return values
mixed —The result
getScheme()
Get the https or http protocol depending on SSL support.
protected
getScheme() : string
Call this only if you know that the server supports both.
Return values
string —The correct type of protocol
shouldCache()
Returns whether or not the given $identifier should be cached or not.
protected
shouldCache(string $identifier) : bool
Parameters
- $identifier : string