https://github.com/stephan-strate/php-cover-art-archive-api
:open_file_folder: PHP 7.4/8.0/8.1 API Wrapper for CoverArtArchive, a joint project between the Internet Archive and MusicBrainz. The wrapper includes mapped models.
https://github.com/stephan-strate/php-cover-art-archive-api
api-client api-wrapper cover-art-archive php
Last synced: 5 months ago
JSON representation
:open_file_folder: PHP 7.4/8.0/8.1 API Wrapper for CoverArtArchive, a joint project between the Internet Archive and MusicBrainz. The wrapper includes mapped models.
- Host: GitHub
- URL: https://github.com/stephan-strate/php-cover-art-archive-api
- Owner: stephan-strate
- License: mit
- Created: 2020-09-20T13:33:16.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-04T20:13:57.000Z (about 3 years ago)
- Last Synced: 2025-08-31T00:59:51.977Z (9 months ago)
- Topics: api-client, api-wrapper, cover-art-archive, php
- Language: PHP
- Homepage:
- Size: 229 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# [CoverArtArchive](https://coverartarchive.org/) API Wrapper
CoverArtArchive is a joint project between the [Internet Archive](https://archive.org/) and [MusicBrainz](https://musicbrainz.org/). Goal of this project is to make cover art images available to everyone.
Using this api wrapper, you can retrieve cover art images using the [release MBID](https://musicbrainz.org/doc/MusicBrainz_Identifier) of MusicBrainz.
Recommended to use together with [stephan-strate/php-music-brainz-api](https://github.com/stephan-strate/php-music-brainz-api).
Inspired by [php-github-api](https://github.com/KnpLabs/php-github-api) and [php-tmdb](https://github.com/php-tmdb/api).
## Installation
Using composer:
```
$ composer require stephan-strate/php-cover-art-archive-api php-http/guzzle7-adapter:^1.0 http-interop/http-factory-guzzle:^1.0
```
Why `php-http/guzzle7-adapter:^1.0`? This library is decoupled from any http client using [HTTPlug](http://httplug.io/).
## Usage
First you want to create the client:
```php
$client = new \CoverArtArchive\Client();
```
Using this client, you can retrieve all other objects/apis.
### Repository
The repository implementation takes the decoded json response and maps it to a matching model. This is the preferred way of using the library.
```php
$repository = new \CoverArtArchive\Repository\ReleaseGroupRepository($client);
$repository->coverArt('19e6209b-2ddc-30b8-9273-484bd075fe7b');
```
#### Images
As the CoverArtArchive serves, as the name implies, images. Therefore the repository can also return image resources.
```php
$repository = new \CoverArtArchive\Repository\ReleaseRepository($client);
$image = $repository->coverArtFront('7416e707-94b5-3810-b6b8-4229ab2182ec');
// outputs the image to the user
if ($image !== false) {
header('Content-Type: image/png');
imagepng($image);
imagedestroy($image);
}
```
### Api
The api implementation returns the raw json response of the endpoint. You might want to use the repository implementation instead to get the parsed objects.
```php
$release = $client->release();
$release->coverArt('7416e707-94b5-3810-b6b8-4229ab2182ec');
```
## Contributing
## Help & Donate
I am very curious about projects that use my libraries. Please drop me a short message about what you use the library for. You can find my contact information on my profile (LinkedIn, E-mail).
If this project saved you time and money or you just appreciate what I am doing, please consider sponsoring me 😊