README

CoverArtArchive API Wrapper

CoverArtArchive is a joint project between the Internet Archive and MusicBrainz. 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 of MusicBrainz.

Recommended to use together with stephan-strate/php-music-brainz-api.

Inspired by php-github-api and php-tmdb.

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.

Usage

First you want to create the client:

$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.

$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.

$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.

$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 😊

stephan-strate / php-cover-art-archive-api

Maintainers

Details