|
| 1 | +# Laravel Packagist |
| 2 | + |
| 3 | +[](https://packagist.org/packages/ingress-it-solutions/laravel-packagist) |
| 4 | +[](https://packagist.org/packages/ingress-it-solutions/laravel-packagist) |
| 5 | + |
| 6 | +A Laravel wrapper for the [spatie/packagist-api](https://github.com/spatie/packagist-api) package. |
| 7 | + |
| 8 | +## Installation |
| 9 | +You can install this package with composer: |
| 10 | + |
| 11 | +```shell |
| 12 | +composer require ingress-it-solutions/laravel-packagist |
| 13 | +``` |
| 14 | + |
| 15 | +Laravel uses Package auto-discovery, so you don't have to register the service provider. If you want to register the service provider manually, add the following line to your `config/app.php` file: |
| 16 | + |
| 17 | +```php |
| 18 | +IngressITSolutions\Packagist\PackagistServiceProvider::class, |
| 19 | +``` |
| 20 | + |
| 21 | +## Usage |
| 22 | + |
| 23 | +There are two main ways how you can make Packagist calls: |
| 24 | + |
| 25 | +**Using the application container** |
| 26 | + |
| 27 | +```php |
| 28 | +/** @var \Spatie\Packagist\PackagistClient $client */ |
| 29 | +$client = app(\Spatie\Packagist\PackagistClient::class); |
| 30 | + |
| 31 | +$client->getPackage('ingress-it-solutions', 'laravel-packagist'); |
| 32 | +``` |
| 33 | + |
| 34 | +**Using the facade** |
| 35 | +```php |
| 36 | +Packagist::getPackage('ingress-it-solutions', 'laravel-packagist'); |
| 37 | +``` |
| 38 | +### Available methods |
| 39 | + |
| 40 | +**List package names** |
| 41 | +```php |
| 42 | +// All packages |
| 43 | +Packagist::getPackagesNames(); |
| 44 | + |
| 45 | +// Filter on type. |
| 46 | +Packagist::getPackagesNamesByType('composer-plugin'); |
| 47 | + |
| 48 | +// Filter on organization |
| 49 | +Packagist::getPackagesNamesByVendor('ingress-it-solutions'); |
| 50 | +``` |
| 51 | + |
| 52 | +**Searching for packages** |
| 53 | +```php |
| 54 | +// Search packages by name. |
| 55 | +Packagist::searchPackagesByName('packagist'); |
| 56 | + |
| 57 | +// Search packages by tag. |
| 58 | +Packagist::searchPackagesByTags('psr-3'); |
| 59 | + |
| 60 | +// Search packages by type. |
| 61 | +Packagist::searchPackagesByType('composer-plugin'); |
| 62 | + |
| 63 | +// Combined search. |
| 64 | +Packagist::searchPackages('packagist', ['type' => 'library']); |
| 65 | +``` |
| 66 | + |
| 67 | +**Pagination** |
| 68 | + |
| 69 | +Searching for packages returns a paginated result. You can change the pagination settings by adding more parameters. |
| 70 | + |
| 71 | +```php |
| 72 | +// Get the third page, 10 items per page. |
| 73 | +Packagist::searchPackagesByName('packagist', 3, 10); |
| 74 | +``` |
| 75 | + |
| 76 | +**Getting package data.** |
| 77 | +```php |
| 78 | +// Using the Composer metadata. (faster, but less data) |
| 79 | +Packagist::getPackageMetadata('ingress-it-solutions/laravel-packagist'); |
| 80 | +Packagist::getPackageMetadata('ingress-it-solutions', 'laravel-packagist'); |
| 81 | + |
| 82 | +// Using the API. (slower, cached for 12 hours by Packagist. |
| 83 | +Packagist::getPackage('ingress-it-solutions/laravel-packagist'); |
| 84 | +Packagist::getPackage('ingress-it-solutions', 'laravel-packagist'); |
| 85 | +``` |
| 86 | + |
| 87 | +**Get Statistics** |
| 88 | +```php |
| 89 | +$packagist->getStatistics(); |
| 90 | +``` |
| 91 | + |
| 92 | +## Configuration |
| 93 | +By default, the api url for Packagist is set to `https://packagist.org`. If you want to override that, you can add the following code block to your `config/services.php` file: |
| 94 | + |
| 95 | +```php |
| 96 | +'packagist' => [ |
| 97 | + 'base_url' => 'https://packagist.org', |
| 98 | + 'repo_url' => 'https://repo.packagist.org', |
| 99 | +], |
| 100 | +``` |
0 commit comments