You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
81 lines
2.1 KiB
PHP
81 lines
2.1 KiB
PHP
<?php
|
|
|
|
namespace Composer\Repository\Vcs;
|
|
|
|
/**
|
|
* @author Jordi Boggiano <j.boggiano@seld.be>
|
|
*/
|
|
interface VcsDriverInterface
|
|
{
|
|
/**
|
|
* Initializes the driver (git clone, svn checkout, fetch info etc)
|
|
*/
|
|
function initialize();
|
|
|
|
/**
|
|
* Return the composer.json file information
|
|
*
|
|
* @param string $identifier Any identifier to a specific branch/tag/commit
|
|
* @return array containing all infos from the composer.json file
|
|
*/
|
|
function getComposerInformation($identifier);
|
|
|
|
/**
|
|
* Return the root identifier (trunk, master, default/tip ..)
|
|
*
|
|
* @return string Identifier
|
|
*/
|
|
function getRootIdentifier();
|
|
|
|
/**
|
|
* Return list of branches in the repository
|
|
*
|
|
* @return array Branch names as keys, identifiers as values
|
|
*/
|
|
function getBranches();
|
|
|
|
/**
|
|
* Return list of tags in the repository
|
|
*
|
|
* @return array Tag names as keys, identifiers as values
|
|
*/
|
|
function getTags();
|
|
|
|
/**
|
|
* @param string $identifier Any identifier to a specific branch/tag/commit
|
|
* @return array With type, url reference and shasum keys.
|
|
*/
|
|
function getDist($identifier);
|
|
|
|
/**
|
|
* @param string $identifier Any identifier to a specific branch/tag/commit
|
|
* @return array With type, url and reference keys.
|
|
*/
|
|
function getSource($identifier);
|
|
|
|
/**
|
|
* Return the URL of the repository
|
|
*
|
|
* @return string
|
|
*/
|
|
function getUrl();
|
|
|
|
/**
|
|
* Return true if the repository has a composer file for a given identifier,
|
|
* false otherwise.
|
|
*
|
|
* @param string $identifier Any identifier to a specific branch/tag/commit
|
|
* @return boolean Whether the repository has a composer file for a given identifier.
|
|
*/
|
|
function hasComposerFile($identifier);
|
|
|
|
/**
|
|
* Checks if this driver can handle a given url
|
|
*
|
|
* @param string $url
|
|
* @param Boolean $shallow unless true, only shallow checks (url matching typically) should be done
|
|
* @return Boolean
|
|
*/
|
|
static function supports($url, $deep = false);
|
|
}
|