Github Api Laravel Package

References API

Back to the navigation

List all references

$references = $client->api('gitData')->references()->all('KnpLabs', 'php-github-api');

List Matching references

$references = $client->api('gitData')->references()->matching('KnpLabs', 'php-github-api', 'heads/branchName'); // use 'tags/tagName' for third argument if ref is tag

Show a reference

$reference = $client->api('gitData')->references()->show('KnpLabs', 'php-github-api', 'heads/featureA');

Create a reference

$referenceData = ['ref' => 'refs/heads/featureA', 'sha' => '839e5185da9434753db47959bee16642bb4f2ce4'];
$reference = $client->api('gitData')->references()->create('KnpLabs', 'php-github-api', $referenceData);

Update a reference

$referenceData = ['sha' => '839e5185da9434753db47959bee16642bb4f2ce4', 'force' => false ]; //Force is default false
$reference = $client->api('gitData')->references()->update('KnpLabs', 'php-github-api', 'heads/featureA', $referenceData);

Delete a reference

$client->api('gitData')->references()->remove('KnpLabs', 'php-github-api', 'heads/featureA');

List all branches

$references = $client->api('gitData')->references()->branches('KnpLabs', 'php-github-api');

List all tags

$references = $client->api('gitData')->references()->tags('KnpLabs', 'php-github-api');