Nosial/ncc
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases 11 Packages Wiki Activity Actions

Updated interface \ncc\Interfaces > RepositorySourceInterface

Browse source 
https://git.n64.cc/nosial/ncc/-/issues/34
This commit is contained in:
Netkas 2022-12-15 17:59:55 -05:00
parent 259620079e
commit bfbd7b4828
1 changed files with 24 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
src/ncc/Interfaces/RepositorySourceInterface.php
View file

@ -4,18 +4,37 @@
use ncc\Objects\DefinedRemoteSource;
use ncc\Objects\RemotePackageInput;
use ncc\Objects\Vault\Entry;
interface RepositorySourceInterface
{
/**
* Fetches a package and all it's dependencies from the given remote source
* and optionally converts and compiles it to a local package, returns the
* fetched package as a path to the ncc package file. This function uses
* a defined remote source to fetch the package or build the package from.
* Returns the git repository url of the repository, versions cannot be specified.
*
* @param RemotePackageInput $packageInput
* @param DefinedRemoteSource $definedRemoteSource
* @param Entry|null $entry
* @return string
*/
public static function fetch(RemotePackageInput $packageInput, DefinedRemoteSource $definedRemoteSource): string;
public static function fetchGitUri(RemotePackageInput $packageInput, DefinedRemoteSource $definedRemoteSource, ?Entry $entry=null): string;
/**
* Returns the release url of the repository, versions can be specified.
*
* @param RemotePackageInput $packageInput
* @param DefinedRemoteSource $definedRemoteSource
* @param Entry|null $entry
* @return string
*/
public static function getRelease(RemotePackageInput $packageInput, DefinedRemoteSource $definedRemoteSource, ?Entry $entry = null): string;
/**
* Returns the download URL of the pre-compiled .ncc package if available
*
* @param RemotePackageInput $packageInput
* @param DefinedRemoteSource $definedRemoteSource
* @param Entry|null $entry
* @return string
*/
public static function getNccPackage(RemotePackageInput $packageInput, DefinedRemoteSource $definedRemoteSource, ?Entry $entry = null): string;
}