Documentation

GitHubDriver extends VcsDriver
in package

A driver implementation for driver with authentication interaction.

Tags
author

Jordi Boggiano j.boggiano@seld.be

Table of Contents

$branches  : mixed
$cache  : Cache
$config  : Config
$gitDriver  : GitDriver
Git Driver
$hasIssues  : mixed
$infoCache  : array<string|int, mixed>
$io  : IOInterface
$isPrivate  : mixed
$originUrl  : string
$owner  : mixed
$process  : ProcessExecutor
$remoteFilesystem  : RemoteFilesystem
$repoConfig  : array<string|int, mixed>
$repoData  : mixed
$repository  : mixed
$rootIdentifier  : mixed
$tags  : mixed
$url  : string
$fundingInfo  : mixed
$isArchived  : mixed
__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}
getRepoData()  : array<string|int, mixed>|null
Gives back the loaded <github-api>/repos/<owner>/<repo> result
getRepositoryUrl()  : mixed
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}
attemptCloneFallback()  : mixed
fetchRootIdentifier()  : mixed
Fetch root identifier from GitHub
generateSshUrl()  : string
Generate an SSH URL
getApiUrl()  : mixed
{@inheritDoc}
getBaseComposerInformation()  : mixed
getContents()  : mixed
Get the remote content.
getNextPage()  : mixed
getScheme()  : string
Get the https or http protocol depending on SSL support.
setupGitDriver()  : mixed
shouldCache()  : bool
Returns whether or not the given $identifier should be cached or not.
getFundingInfo()  : mixed

Properties

$infoCache

protected array<string|int, mixed> $infoCache = array()

$repoConfig

protected array<string|int, mixed> $repoConfig

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 —

getRepoData()

Gives back the loaded <github-api>/repos/<owner>/<repo> result

public getRepoData() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —

getRepositoryUrl()

public getRepositoryUrl() : 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 —

attemptCloneFallback()

protected attemptCloneFallback() : mixed
Return values
mixed —

fetchRootIdentifier()

Fetch root identifier from GitHub

protected fetchRootIdentifier() : mixed
Tags
throws
TransportException
Return values
mixed —

generateSshUrl()

Generate an SSH URL

protected generateSshUrl() : string
Return values
string —

getApiUrl()

{@inheritDoc}

protected getApiUrl() : mixed
Return values
mixed —

getBaseComposerInformation()

protected getBaseComposerInformation(mixed $identifier) : mixed
Parameters
$identifier : mixed
Return values
mixed —

getContents()

Get the remote content.

protected getContents(mixed $url[, mixed $fetchingRepoData = false ]) : mixed
Parameters
$url : mixed

The URL of content

$fetchingRepoData : mixed = false
Return values
mixed —

The result

getNextPage()

protected getNextPage() : mixed
Return values
mixed —

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

setupGitDriver()

protected setupGitDriver(mixed $url) : mixed
Parameters
$url : mixed
Return values
mixed —

shouldCache()

Returns whether or not the given $identifier should be cached or not.

protected shouldCache(string $identifier) : bool
Parameters
$identifier : string
Return values
bool —

getFundingInfo()

private getFundingInfo() : mixed
Return values
mixed —

Search results