\Composer\Repository\VcsHgBitbucketDriver

A driver implementation for driver with authentication interaction.

Summary

Methods

Properties

Constants

initialize()
getUrl()
getComposerInformation()
getFileContent()
getChangeDate()
getSource()
getDist()
getTags()
getBranches()
__construct()
hasComposerFile()
cleanup()
getRootIdentifier()
supports()

No public properties found

No constants found

getRepoData()
getContentsWithOAuthCredentials()
generateSshUrl()
attemptCloneFallback()
setupFallbackDriver()
parseCloneUrls()
getMainBranchData()
shouldCache()
getBaseComposerInformation()
getScheme()
getContents()

$cache
$owner
$repository
$hasIssues
$rootIdentifier
$tags
$branches
$infoCache
$branchesUrl
$tagsUrl
$homeUrl
$website
$cloneHttpsUrl
$fallbackDriver
$vcsType
$url
$originUrl
$repoConfig
$io
$config
$process
$remoteFilesystem

N/A

No private methods found

No private properties found

N/A

File: vendor/composer/composer/src/Composer/Repository/Vcs/HgBitbucketDriver.php
Package: Default
Class hierarchy: \Composer\Repository\Vcs\VcsDriver

\Composer\Repository\Vcs\BitbucketDriver

\Composer\Repository\Vcs\HgBitbucketDriver

Properties

$cache

$cache : \Composer\Cache

Type

\Composer\Cache

$owner

$owner :

Type

$repository

$repository :

Type

$hasIssues

$hasIssues :

Type

$rootIdentifier

$rootIdentifier :

Type

$tags

$tags :

Type

$branches

$branches :

Type

$infoCache

$infoCache : array

Type

array

$branchesUrl

$branchesUrl :

Type

$tagsUrl

$tagsUrl :

Type

$homeUrl

$homeUrl :

Type

$website

$website :

Type

$cloneHttpsUrl

$cloneHttpsUrl :

Type

$fallbackDriver

$fallbackDriver : \Composer\Repository\Vcs\VcsDriver

Type

\Composer\Repository\Vcs\VcsDriver

$vcsType

$vcsType : string|null

Type

string|null — if set either git or hg

$url

$url : string

Type

string

$originUrl

$originUrl : string

Type

string

$repoConfig

$repoConfig : array

Type

array

$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

$remoteFilesystem

$remoteFilesystem : \Composer\Util\RemoteFilesystem

Type

\Composer\Util\RemoteFilesystem

Methods

initialize()

initialize()

{@inheritDoc}

getUrl()

getUrl()

{@inheritDoc}

getComposerInformation()

getComposerInformation(string  $identifier) : array

Return the composer.json file information

Parameters

string

$identifier

Any identifier to a specific branch/tag/commit

Returns

array —

containing all infos from the composer.json file

getFileContent()

getFileContent(  $file,   $identifier)

{@inheritdoc}

Parameters

	$file
	$identifier

getChangeDate()

getChangeDate(  $identifier)

{@inheritdoc}

Parameters

$identifier

getSource()

getSource(  $identifier)

{@inheritDoc}

Parameters

$identifier

getDist()

getDist(  $identifier)

{@inheritDoc}

Parameters

$identifier

getTags()

getTags()

{@inheritDoc}

getBranches()

getBranches()

{@inheritDoc}

__construct()

__construct(array  $repoConfig, \Composer\IO\IOInterface  $io, \Composer\Config  $config, \Composer\Util\ProcessExecutor  $process = null, \Composer\Util\RemoteFilesystem  $remoteFilesystem = null)

Constructor.

Parameters

array	$repoConfig	The repository configuration
\Composer\IO\IOInterface	$io	The IO instance
\Composer\Config	$config	The composer configuration
\Composer\Util\ProcessExecutor	$process	Process instance, injectable for mocking
\Composer\Util\RemoteFilesystem	$remoteFilesystem	Remote Filesystem, injectable for mocking

hasComposerFile()

hasComposerFile(string  $identifier) : boolean

Return true if the repository has a composer file for a given identifier, false otherwise.

Parameters

string

$identifier

Any identifier to a specific branch/tag/commit

Returns

boolean —

Whether the repository has a composer file for a given identifier.

cleanup()

cleanup()

Performs any cleanup necessary as the driver is not longer needed

getRootIdentifier()

getRootIdentifier()

{@inheritDoc}

supports()

supports(\Composer\IO\IOInterface  $io, \Composer\Config  $config,   $url,   $deep = false)

{@inheritDoc}

Parameters

\Composer\IO\IOInterface	$io
\Composer\Config	$config
	$url
	$deep

getRepoData()

getRepoData() : boolean

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

Returns

boolean

getContentsWithOAuthCredentials()

getContentsWithOAuthCredentials(string  $url, boolean  $fetchingRepoData = false) : mixed

Get the remote content.

Parameters

string	$url	The URL of content
boolean	$fetchingRepoData

Returns

mixed —

The result

generateSshUrl()

generateSshUrl() : string

Generate an SSH URL

Returns

string

attemptCloneFallback()

attemptCloneFallback()

setupFallbackDriver()

setupFallbackDriver(string  $url) : void

Parameters

string

$url

parseCloneUrls()

parseCloneUrls(array  $cloneLinks) : void

Parameters

array

$cloneLinks

getMainBranchData()

getMainBranchData() : array|null

Returns

array|null

shouldCache()

shouldCache(string  $identifier) : boolean

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

Parameters

string

$identifier

Returns

boolean

getBaseComposerInformation()

getBaseComposerInformation(  $identifier)

Parameters

$identifier

getScheme()

getScheme() : string

Get the https or http protocol depending on SSL support.

Call this only if you know that the server supports both.

Returns

string —

The correct type of protocol

getContents()

getContents(string  $url) : mixed

Get the remote content.

Parameters

string

$url

The URL of content

Returns

mixed —

The result

<?php

/*
 * This file is part of Composer.
 *
 * (c) Nils Adermann <naderman@naderman.de>
 *     Jordi Boggiano <j.boggiano@seld.be>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Composer\Repository\Vcs;

use Composer\Config;
use Composer\IO\IOInterface;

/**
 * @author Per Bernhardt <plb@webfactory.de>
 */
class HgBitbucketDriver extends BitbucketDriver
{
    /**
     * {@inheritDoc}
     */
    public function getRootIdentifier()
    {
        if ($this->fallbackDriver) {
            return $this->fallbackDriver->getRootIdentifier();
        }

        if (null === $this->rootIdentifier) {
            if (! $this->getRepoData()) {
                return $this->fallbackDriver->getRootIdentifier();
            }

            if ($this->vcsType !== 'hg') {
                throw new \RuntimeException(
                    $this->url.' does not appear to be a mercurial repository, use '.
                    $this->cloneHttpsUrl.' if this is a git bitbucket repository'
                );
            }

            $mainBranchData = $this->getMainBranchData();
            $this->rootIdentifier = !empty($mainBranchData['name']) ? $mainBranchData['name'] : 'default';
        }

        return $this->rootIdentifier;
    }

    /**
     * {@inheritDoc}
     */
    public static function supports(IOInterface $io, Config $config, $url, $deep = false)
    {
        if (!preg_match('#^https?://bitbucket\.org/([^/]+)/([^/]+)/?$#', $url)) {
            return false;
        }

        if (!extension_loaded('openssl')) {
            $io->writeError('Skipping Bitbucket hg driver for '.$url.' because the OpenSSL PHP extension is missing.', true, IOInterface::VERBOSE);

            return false;
        }

        return true;
    }

    /**
     * {@inheritdoc}
     */
    protected function setupFallbackDriver($url)
    {
        $this->fallbackDriver = new HgDriver(
            array('url' => $url),
            $this->io,
            $this->config,
            $this->process,
            $this->remoteFilesystem
        );
        $this->fallbackDriver->initialize();
    }

    /**
     * {@inheritdoc}
     */
    protected function generateSshUrl()
    {
        return 'ssh://hg@' . $this->originUrl . '/' . $this->owner.'/'.$this->repository;
    }
}