atomescrochus/laravel-deezer-api

An easy way to interact with the Deezer API from any Laravel >= 5.3 application.

Search the Deezer Web API

, _(*1)

The atomescrochus/laravel-deezer-api package provide and easy way to search the Deezer Web API from any Laravel >= 5.3 application., _(*2)

This package is usable in production, but should still be considered a work in progress (contribution welcomed!). It requires PHP >= 7.0., _(*3)

Install

You can install this package via composer:, _(*4)

``` bash $ composer require atomescrochus/laravel-deezer-api, <sub>(*5)</sub>

Then you have to install the package' service provider, _unless you are running Laravel >=5.5_ (it'll use package auto-discovery) :

```php
// config/app.php
'providers' => [
    ...
    Atomescrochus\Deezer\DeezerApiServiceProvider::class,
];

Usage

``` php // here is an example query to search Deezer's API $deezer = new \Atomescrochus\Deezer\Deezer();, <sub>(*6)</sub>

// You can execute a basic search, and hope for the best $results = $deezer->basicSearch("yolo");, <sub>(*7)</sub>

// If you already have a Deezer ID, you can do thise to get the track $results = $deezer->getTrackById(18042083); //, <sub>(*8)</sub>

// But you can also execute more complex search $results = $deezer->artist() // string ->album() // string ->track() // string ->label() // string ->minimumDuration() // int ->maximumDuration() // int ->minimumBPM() // int ->maximumBPM() // int ->search();, <sub>(*9)</sub>

// These are the options you can set with every kind of call $deezer->cache(120) // an integer (number of minutes), for the cache to expire, can be 0, <sub>(*10)</sub>

// Theses are options compatible with basicSearch() and complexe searches $deezer->strictMode() // deactivate fuzzy searching on Deezer's side $deezer->type('track') // defaults to track if not set. // see http://developers.deezer.com/api/search#connections for possible search types $deezer->order('ranking') // defaults to ranking if not set. Use lower case! // see http://developers.deezer.com/api/search#infos for possible order ```, <sub>(*11)</sub>

Results

In the example above, what is returned in $results is an object containing: a collection of results; a count value for the results; raw response data; and the unformatted query sent to the API., <sub>(*12)</sub>

Tests

This is basically a wrapper around the API. We're assuming the Deezer API has been tested, and we won't duplicated tests., <sub>(*13)</sub>

Change log

Please see CHANGELOG for more information on what has changed recently., <sub>(*14)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*15)</sub>

Security

If you discover any security related issues, please email jp@atomescroch.us instead of using the issue tracker., <sub>(*16)</sub>

Credits

• Jean-Philippe Murray
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*17)</sub>