VcsDriverInterface
in
Tags
Table of Contents
- cleanup() : mixed
- Performs any cleanup necessary as the driver is not longer needed
- getBranches() : array<string|int, mixed>
- Return list of branches in the repository
- getChangeDate() : DateTime
- Get the changedate for $identifier.
- getComposerInformation() : array<string|int, mixed>
- Return the composer.json file information
- getDist() : array<string|int, mixed>
- getFileContent() : string
- Return the content of $file or null if the file does not exist.
- getRootIdentifier() : string
- Return the root identifier (trunk, master, default/tip ..)
- getSource() : array<string|int, mixed>
- getTags() : array<string|int, mixed>
- Return list of tags in the repository
- getUrl() : string
- Return the URL of the repository
- hasComposerFile() : bool
- Return true if the repository has a composer file for a given identifier, false otherwise.
- initialize() : mixed
- Initializes the driver (git clone, svn checkout, fetch info etc)
- supports() : bool
- Checks if this driver can handle a given url
Methods
cleanup()
Performs any cleanup necessary as the driver is not longer needed
public
cleanup() : mixed
Return values
mixed —getBranches()
Return list of branches in the repository
public
getBranches() : array<string|int, mixed>
Return values
array<string|int, mixed> —Branch names as keys, identifiers as values
getChangeDate()
Get the changedate for $identifier.
public
getChangeDate(string $identifier) : DateTime
Parameters
- $identifier : string
Return values
DateTime —getComposerInformation()
Return the composer.json file information
public
getComposerInformation(string $identifier) : array<string|int, mixed>
Parameters
- $identifier : string
-
Any identifier to a specific branch/tag/commit
Return values
array<string|int, mixed> —containing all infos from the composer.json file
getDist()
public
getDist(string $identifier) : array<string|int, mixed>
Parameters
- $identifier : string
-
Any identifier to a specific branch/tag/commit
Return values
array<string|int, mixed> —With type, url reference and shasum keys.
getFileContent()
Return the content of $file or null if the file does not exist.
public
getFileContent(string $file, string $identifier) : string
Parameters
- $file : string
- $identifier : string
Return values
string —getRootIdentifier()
Return the root identifier (trunk, master, default/tip ..)
public
getRootIdentifier() : string
Return values
string —Identifier
getSource()
public
getSource(string $identifier) : array<string|int, mixed>
Parameters
- $identifier : string
-
Any identifier to a specific branch/tag/commit
Return values
array<string|int, mixed> —With type, url and reference keys.
getTags()
Return list of tags in the repository
public
getTags() : array<string|int, mixed>
Return values
array<string|int, mixed> —Tag names as keys, identifiers as values
getUrl()
Return the URL of the repository
public
getUrl() : string
Return values
string —hasComposerFile()
Return true if the repository has a composer file for a given identifier, false otherwise.
public
hasComposerFile(string $identifier) : bool
Parameters
- $identifier : string
-
Any identifier to a specific branch/tag/commit
Return values
bool —Whether the repository has a composer file for a given identifier.
initialize()
Initializes the driver (git clone, svn checkout, fetch info etc)
public
initialize() : mixed
Return values
mixed —supports()
Checks if this driver can handle a given url
public
static supports(IOInterface $io, Config $config, string $url[, bool $deep = false ]) : bool
Parameters
- $io : IOInterface
-
IO instance
- $config : Config
-
current $config
- $url : string
-
URL to validate/check
- $deep : bool = false
-
unless true, only shallow checks (url matching typically) should be done