vk/php-sdk

VK SDK for PHP

v1.0 2018-01-30 12:13 UTC

Requires

• php: >=5.4
• vkcom/vk-api-schema: ^1.4.1

Requires (Dev)

• phpunit/phpunit: 5.2.*

MIT

• sdk
• vk

README

PHP library for VK API interaction, includes OAuth 2.0 authorization and API methods. Full VK API features documentation can be found here.

This library has been created using the VK API JSON Schema. It can be found here. It uses VK API version 5.69.

1. Installation

The VK PHP SDK can be installed using Composer by running the following command:

composer require vk/php-sdk

2. Initialization

Create VKAPIClient object using the following code:

$vk = new VKAPIClient();

3. Authorization

The library provides the authorization flows for user based on OAuth 2.0 protocol implementation in vk.com API. Please read the full documentation before you start.

3.1. Authorization Code Flow for User

OAuth 2.0 Authorization Code Flow allows calling methods from the server side.

This flow includes two steps — obtaining an authorization code and exchanging the code for an access token. Primarily you should obtain the "code" (manual) by redirecting the user to the authorization page using the following method:

$oauth = new VKOAuth();

$oauth->authorize('{client_id}', '{redirect_uri}', '{display}', '{scope_array}', 
    OAuthResponseType::CODE, '{api_version}', '{state}');

As a '{display}' you should pass a constant from the OAuthDisplay class. The '{scope_array}' should be an array of constants from the OAuthUserScope class.

Example:

$oauth->authorize(6125390, 'http://example.com', OAuthDisplay::POPUP, array(OAuthUserScope::AUDIO, OAuthUserScope::DOCS), 
    OAuthResponseType::CODE, '5.69', 'some  state');

After successful authorization user's browser will be redirected to the specified redirect_uri. Meanwhile the code will be sent as a GET parameter to the specified address:

REDIRECT_URI?code=CODE

Then use this method to get the access token:

$access_token = $oauth->getAccessToken('{client_id}', '{client_secret}', '{redirect_uri}', '{code}');

The '{redirect_uri}' should be the URL that was used to get a code at the first step.

Example:

$access_token = $oauth->getAccessToken(6125390, 'Dv3Ef3srY3d2GE1c1X0F', 'http://example.com', '4g2h79rd3f7580a23d');

4. API Requests

You can find the full list of VK API methods here.

Request sample

Example of calling method users.get:

$users = array(1, 210700286);
$fields = array('city', 'photo');

$response = $vk->users()->get($access_token, array(
    'user_ids' => $users,
    'fields' => $fields
    )
);

Uploading Photos into a Private Message

Please read the full manual before the start.

Call photos.getMessagesUploadServer to receive an upload address:

$address = $vk->photos()->getMessagesUploadServer('{access_token}');

Then use upload() method to send files to the upload_url address received in the previous step:

$photo = $vk->request()->upload($address['upload_url'], 'photo', '/Users/Me/Documents/Photos/my_photo.jpg');

You will get a JSON object with server, photo, hash fields. To save a photo call photos.saveMessagesPhoto with these three parameters:

$response_save_photo = $vk->photos()->saveMessagesPhoto($access_token, array(
    'server' => $photo['server'],
    'photo' => $photo['photo'],
    'hash' => $photo['hash']
    )
);

Then you can use 'owner_id' and 'id' parameters from the last response to create an attachment of the uploaded photo.

Uploading Video Files

Please read the full manual before the start.

Call video.save to get a video upload server address:

$address = $vk->video()->save($access_token, array(
    'name' => 'My video',
    )
);

Send a file to upload_url received previously calling upload() method:

$video = $vk->request()->upload($address['upload_url'], 'video_file', '/Users/Me/Documents/Videos/my_video.mp4');

Videos are processed for some time after uploading.

6. Callback API LongPoll handler

Enable Callback API LongPoll for your group and specify which events should be tracked by calling the following API method:

$vk->groups()->setLongPollSettings($access_token, array(
   'group_id' => 159895463,
   'enabled' => 1,
   'message_new' => 1,
   'wall_post_new' => 1,
));

Override methods from CallbackApiHandler class for handling events:

class CallbackAPIMyHandler extends CallbackApiHandler {
    public function messageNew($object) {
        var_dump('New message: ' . $object['body']);
    }
    
    public function wallPostNew($object) {
        var_dump('New wall post: ' . $object['text']);
    }
}

To start listening to LongPoll events, create an instance of your CallbackAPIMyHandler class, instance of CallbackApiLongPollExecutor class and call method run():

$handler = new CallbackApiMyHandler();
$executor = new CallbackApiLongPollExecutor($vk, '{access_token}', '{$group_id}', $handler, '{$wait}');
$executor->listen();

Parameter '{wait}' is the waiting period.

While calling function listen() you can also specify the number of the event from which you want to receive data. The default value is the number of the last event.

Example:

$executor = new CallbackApiLongPollExecutor($vk, $access_token, 159895463, $handler, 25);
$executor->listen(12);