Documentation

GithubApi
in package

Table of Contents

$downloader  : HttpDownloader|RemoteFilesystem
__construct()  : mixed
findRecipeCommitDataFromTreeRef()  : array<string|int, mixed>|null
Attempts to find data about when the recipe was installed.
getCommitDataForPath()  : array<string|int, mixed>
getPullRequestForCommit()  : array<string|int, mixed>|null
getVersionsOfRecipe()  : array<string|int, mixed>|null
getRepositoryName()  : string|null
Converts the "repo" stored in symfony.lock to a repository name.
requestGitHubApi()  : mixed

Properties

$downloader

private HttpDownloader|RemoteFilesystem $downloader

Methods

__construct()

public __construct(mixed $downloader) : mixed
Parameters
$downloader : mixed
Return values
mixed

findRecipeCommitDataFromTreeRef()

Attempts to find data about when the recipe was installed.

public findRecipeCommitDataFromTreeRef(string $package, string $repo, string $branch, string $version, string $lockRef) : array<string|int, mixed>|null

Returns an array containing: commit: The git sha of the last commit of the recipe date: The date of the commit new_commits: An array of commit sha's in this recipe's directory+version since the commit The key is the sha & the value is the date

Parameters
$package : string
$repo : string
$branch : string
$version : string
$lockRef : string
Return values
array<string|int, mixed>|null

getCommitDataForPath()

public getCommitDataForPath(string $repo, string $path, string $branch) : array<string|int, mixed>
Parameters
$repo : string
$path : string
$branch : string
Return values
array<string|int, mixed>

getPullRequestForCommit()

public getPullRequestForCommit(string $commit, string $repo) : array<string|int, mixed>|null
Parameters
$commit : string
$repo : string
Return values
array<string|int, mixed>|null

getVersionsOfRecipe()

public getVersionsOfRecipe(string $repo, string $branch, string $recipePath) : array<string|int, mixed>|null
Parameters
$repo : string
$branch : string
$recipePath : string
Return values
array<string|int, mixed>|null

getRepositoryName()

Converts the "repo" stored in symfony.lock to a repository name.

private getRepositoryName(string $repo) : string|null

For example: "github.com/symfony/recipes" => "symfony/recipes"

Parameters
$repo : string
Return values
string|null

requestGitHubApi()

private requestGitHubApi(string $path) : mixed
Parameters
$path : string
Return values
mixed

Search results