Documentation

BitbucketDriver extends VcsDriver
in package

A driver implementation for driver with authentication interaction.

Table of Contents

$branches  : mixed
$branchesUrl  : mixed
$cache  : Cache
$cloneHttpsUrl  : mixed
$config  : Config
$fallbackDriver  : VcsDriver
$hasIssues  : mixed
$homeUrl  : mixed
$infoCache  : array<string|int, mixed>
$io  : IOInterface
$originUrl  : string
$owner  : mixed
$process  : ProcessExecutor
$remoteFilesystem  : RemoteFilesystem
$repoConfig  : array<string|int, mixed>
$repository  : mixed
$rootIdentifier  : mixed
$tags  : mixed
$tagsUrl  : mixed
$url  : string
$vcsType  : string|null
$website  : 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}
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}
attemptCloneFallback()  : mixed
generateSshUrl()  : string
Generate an SSH URL
getBaseComposerInformation()  : mixed
getContents()  : mixed
Get the remote content.
getContentsWithOAuthCredentials()  : mixed
Get the remote content.
getMainBranchData()  : array<string|int, mixed>|null
getRepoData()  : bool
Attempts to fetch the repository data via the BitBucket API and sets some parameters which are used in other methods
getScheme()  : string
Get the https or http protocol depending on SSL support.
parseCloneUrls()  : void
setupFallbackDriver()  : void
shouldCache()  : bool
Returns whether or not the given $identifier should be cached or not.

Properties

$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 —

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 —

attemptCloneFallback()

protected attemptCloneFallback() : mixed
Return values
mixed —

generateSshUrl()

Generate an SSH URL

protected abstract generateSshUrl() : string
Return values
string —

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

getContentsWithOAuthCredentials()

Get the remote content.

protected getContentsWithOAuthCredentials(string $url[, bool $fetchingRepoData = false ]) : mixed
Parameters
$url : string

The URL of content

$fetchingRepoData : bool = false
Return values
mixed —

The result

getMainBranchData()

protected getMainBranchData() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —

getRepoData()

Attempts to fetch the repository data via the BitBucket API and sets some parameters which are used in other methods

protected getRepoData() : bool
Return values
bool —

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

parseCloneUrls()

protected parseCloneUrls(array<string|int, mixed> $cloneLinks) : void
Parameters
$cloneLinks : array<string|int, mixed>
Return values
void —

setupFallbackDriver()

protected abstract setupFallbackDriver(string $url) : void
Parameters
$url : string
Return values
void —

shouldCache()

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

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

Search results