chipslays / vk-music
A simple wrapper for VK Music API.
1.0.1
2021-06-30 10:05 UTC
Requires
- chipslays/collection: ^1.1
Requires (Dev)
- phpunit/phpunit: ^9.5
This package is auto-updated.
Last update: 2024-12-29 06:34:42 UTC
README
A simple wrapper for VK Music API.
For use this library, first you need get a token and user-agent.
See for more
vodka2/vk-audio-token
.
Installation
composer require chipslays/vk-music
Usage
use Chipslays\VkMusic\Client; $client = new Client('YOUR_TOKEN', 'YOUR_USERAGENT'); $response = $client->search('Justin Bieber - Baby'); print_r($response->toArray()); // Array // ( // [count] => 3693 // [items] => Array // ( // [0] => ... // [1] => ... // [2] => ... // ) // )
You can get the value using dot notation by chipslays/collection
.
print_r($response->get('items.0.artist'));
Methods
NOTICE: Optional parameter
$extra
is a array of parameters withkey => value
.
search(string $q, int $count = 10, int $offset = 0, array $extra = []): Collection
$client->search('Justin Bieber - Baby');
getById(string|array $audios): Collection
$client->getById(['371745461_456289486', '-41489995_202246189']);
get($owner_id, int $count = 10, int $offset = 0, $extra = []): Collection
$client->get('371745461');
getPlaylists($owner_id, int $count = 10): Collection
$client->getPlaylists('371745461');
getRecommendations(int $count = 10): Collection
$client->getRecommendations();
getPopular(int $count = 10): Collection
$client->getPopular();
method(string $method, array $params): Collection
$client->method('audio.search', [ 'q' => 'Justin Bieber - Baby', 'count' => '10', ]);
Helpers
You can use vk_music
helper instead Client
class.
$client = vk_music('YOUR_TOKEN', 'YOUR_USERAGENT');
Todo
- Write tests 😴💤
License
MIT