Skip to content

Commit 7b315a0

Browse files
authored
Merge pull request #80 from packagist/subrepo-package-id-changes
Mention subrepository package id changes
2 parents bca533e + c8e2c04 commit 7b315a0

File tree

2 files changed

+16
-10
lines changed

2 files changed

+16
-10
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -614,9 +614,15 @@ $packages = $client->subrepositories()->packages()->all($subrepositoryName);
614614
Returns an array of subrepositories packages.
615615

616616
#### Show a subrepository package
617+
618+
You can reference a package by its name or ID.
619+
617620
```php
618621
$subrepositoryName = 'subrepository';
622+
// Either use package name:
619623
$package = $client->subrepositories()->packages()->show($subrepositoryName, 'acme-website/package');
624+
// Or the package ID:
625+
$package = $client->subrepositories()->packages()->show($subrepositoryName, 123);
620626
```
621627
Returns the package.
622628

src/Api/Subrepositories/Packages.php

+10-10
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ public function all($subrepositoryName, array $filters = [])
2525
return $this->get(sprintf('/subrepositories/%s/packages/', $subrepositoryName), $filters);
2626
}
2727

28-
public function show($subrepositoryName, $packageName)
28+
public function show($subrepositoryName, $packageIdOrName)
2929
{
30-
return $this->get(sprintf('/subrepositories/%s/packages/%s', $subrepositoryName, $packageName));
30+
return $this->get(sprintf('/subrepositories/%s/packages/%s', $subrepositoryName, $packageIdOrName));
3131
}
3232

3333
public function createVcsPackage($subrepositoryName, $url, $credentialId = null, $type = 'vcs', $defaultSubrepositoryAccess = null)
@@ -44,27 +44,27 @@ public function createCustomPackage($subrepositoryName, $customJson, $credential
4444
return $this->post(sprintf('/subrepositories/%s/packages/', $subrepositoryName), $data->toParameters());
4545
}
4646

47-
public function editVcsPackage($subrepositoryName, $packageName, $url, $credentialId = null, $type = 'vcs', $defaultSubrepositoryAccess = null)
47+
public function editVcsPackage($subrepositoryName, $packageIdOrName, $url, $credentialId = null, $type = 'vcs', $defaultSubrepositoryAccess = null)
4848
{
4949
$data = new VcsPackageConfig($url, $credentialId, $type, $defaultSubrepositoryAccess);
5050

51-
return $this->put(sprintf('/subrepositories/%s/packages/%s/', $subrepositoryName, $packageName), $data->toParameters());
51+
return $this->put(sprintf('/subrepositories/%s/packages/%s/', $subrepositoryName, $packageIdOrName), $data->toParameters());
5252
}
5353

54-
public function editCustomPackage($subrepositoryName, $packageName, $customJson, $credentialId = null, $defaultSubrepositoryAccess = null)
54+
public function editCustomPackage($subrepositoryName, $packageIdOrName, $customJson, $credentialId = null, $defaultSubrepositoryAccess = null)
5555
{
5656
$data = new CustomPackageConfig($customJson, $credentialId, $defaultSubrepositoryAccess);
5757

58-
return $this->put(sprintf('/subrepositories/%s/packages/%s/', $subrepositoryName, $packageName), $data->toParameters());
58+
return $this->put(sprintf('/subrepositories/%s/packages/%s/', $subrepositoryName, $packageIdOrName), $data->toParameters());
5959
}
6060

61-
public function remove($subrepositoryName, $packageName)
61+
public function remove($subrepositoryName, $packageIdOrName)
6262
{
63-
return $this->delete(sprintf('/subrepositories/%s/packages/%s/', $subrepositoryName, $packageName));
63+
return $this->delete(sprintf('/subrepositories/%s/packages/%s/', $subrepositoryName, $packageIdOrName));
6464
}
6565

66-
public function listDependents($subrepositoryName, $packageName)
66+
public function listDependents($subrepositoryName, $packageIdOrName)
6767
{
68-
return $this->get(sprintf('/subrepositories/%s/packages/%s/dependents/', $subrepositoryName, $packageName));
68+
return $this->get(sprintf('/subrepositories/%s/packages/%s/dependents/', $subrepositoryName, $packageIdOrName));
6969
}
7070
}

0 commit comments

Comments
 (0)