Доступные классы

Класс vk_api

Инициализация класса

$vk = vk_api::create('токен группы или пользователя', 'версия api'); авторизация через токен группы/пользователя
$vk = vk_api::create('логин', 'пароль', 'версия api'); авторизация через логин/пароль пользователя
$vk = vk_api::create('экземпляр класса Auth', 'версия api'); использование уже готовой авторизации

Методы класса

reply($message, $params = []) - отправка сообщения тому, от кого пришел callback(личка пользователя или беседа)
- $params - массив доп параметров для метода messages.send. Прим: [‘attachment’ => ‘wall_-123_123’]
sendMessage($id, $message, $params = []) - отправка сообщения
- $params - массив доп параметров для метода messages.send. Прим: [‘attachment’ => ‘wall_-123_123’]
sendButton($id, $message, $buttons = [], $inline = false, $one_time = False, $params = []) - отправка клавиатуры (только если отправитель - группа)
- $user_id - id пользователя, которому нужно отправить клавиатуру
- $message - сообщение, прикреплённое к клавиатуре(обязательный параметр)
- $buttons - массив клавиатуры
- $one_time - исчезнет ли клавиатура после того, как пользователь ей воспользуется?
- $params - массив доп параметров для метода messages.send. Прим: [‘attachment’ => ‘wall_-123_123’]
forward($id, $id_messages, $params = []) - пересылает один или несколько сообщений
- $id - id пользователя или беседы
- $id_messages - может принимать либо id сообщения, либо массив с несколькими id сообщений
- $params - массив доп параметров для метода messages.send. Прим: [‘attachment’ => ‘wall_-123_123’]
generateKeyboard($buttons = [], $inline = false, $one_time = false) - метод для генерации клавиатуры. Используется для создания клавиатуры для sendAllDialogs, или для других методов, где нужно передать уже собранную клавиатуру в messages.send
dateRegistration($id) - возвращает дату регистрации пользователя в формате 12:01:02 08.08.2008
groupInfo($group_url) - Возвращает информацию о группе
- $group_url - ссылка на группу в любом виде или id группы
userInfo($user_url = null, $scope = []) - Возвращает информацию о пользователе
- $user_url - ссылка на пользователя в любом виде или его id
- $scope - дополнительные параметры запроса к api, в формате: [‘параметр’ => ‘значение’,…]
request($method, $params = []) - универсальная функция для работы с любыми методами api vk
- $method - метод
- $params - параметры в формате: [‘параметр’ => ‘значение’,…]
sendImage($id, $local_file_path, $params = []) - отправка изображения
- $id - id того, кому отправится сообщение
- $local_file_path - путь до изображения
- $params - массив доп параметров для метода messages.send. Прим: [‘attachment’ => ‘wall_-123_123’]
uploadDocsGroup($groupID, $local_file_path, $title = null) - загрузка документа в документы сообщества
- $groupID - id сообщества
- $local_file_path - путь до файла
- $title - название файла (если не указать, то останется локальное название)
uploadDocsUser($local_file_path, $title = null) - загрузка документа в документы пользователя (только с ключем пользователя)
- $local_file_path - путь до файла
- $title - название файла (если не указать, то останется локальное название)
sendDocMessage($id, $local_file_path, $title = null, $params = []) - отправка документа
- $id - id получателя
- $local_file_path - путь до файла
- $title - название файла (если не указать, то останется локальное название)
- $params - массив доп параметров для метода messages.send (нельзя использовать attachment). Прим: [‘message’ => ‘Привет!’]
sendVoice($id, $local_file_path, $params = []) - отправляет аудиофайл с расширениями |.mp3|.ogg|.pcm|.wav| как голосовое сообщение
- $id - id получателя
- $local_file_path - путь до файла
- $params - массив доп параметров для метода messages.send (нельзя использовать attachment). Прим: [‘message’ => ‘Привет!’]
getGroupsUser($id = [], $extended = 1, $props = []) - возвращает информацию о группах пользователя (только с ключом пользователя)
- $id - id пользователя, информацию о группах которого надо получить(если не указать, вернёт информацию о пользователе, чей токен)
- $extended - (1 - подробно, 0 - нет)
- $props - дополнительные параметры запроса к api, в формате: [‘параметр’ => ‘значение’,…]
setConfirm($str) - устанавливает строку подтверждения сервера. Подтверждает автоматически
- $str - строка, которую должен вернуть сервер для подтверждения
debug() - включает режим вывода ошибок
initVars($id, $message, $payload, $user_id, $type, $data) - инициализирует переменные

Вы можете назвать переменные по другому, но важно сохранить их порядок. Так же вы можете только часть переменных, например $id, $message а остальные не указывать. Но вы НЕ можете сделать так initVars($id, $type), нужно указать все переменные стоящие до $type. Так же функция возвращает $data(весь json от вк в виде объекта), поэтому можно писать так:

$data = $vk->initVars($id, $message);
$time = $data->object->date;

//пример кода  
$vk = vk_api::create(TOKEN, VERSION)->setConfirm(CONFIRM_STR);  
$vk->initVars($id, $message, $payload, $user_id, $type, $data);
$vk->reply($message); //отвечает пользователю или в беседу

sendWallComment($owner_id, $post_id, $message) - отправляет комментарий под постом
- $owner_id - id пользователя
- $post_id - id поста
- $message - сообщение
getAlias($id, $n = null); - возвращает обращение к пользователю или группе в виде строки по типу @id123 или @public123
- $id - id пользователя или группы, так же можно указать короткий адрес
- $n - принимает 3 параметра или можно не указывать
  - если не указать - вернет обращение в виде id
  - true - вернет Имя и Фамилию пользователя или название группы. Пример: @id1(Павел Дуров)
  - false - вернет только Имя пользователя или название группы Пример: @id1(Павел)
  - любая кастомная строка, например Котик - Пример: @id1(Котик)
sendAllDialogs($message, $keyboard = null, $filter = 'all', $params = []) - Отправляет сообщение во все диалоги в группе или личной странице(зависит от способа авторизации)
- $message - отправляемый текст
- $keyboard - сгенерированная клавиатура методом generateKeyboard(). Пример кода ниже
- $filter - фильтр диалогов, может принимать такие параметры:
  - all — все беседы
  - unread — беседы с непрочитанными сообщениями;
  - important — беседы, помеченные как важные(только для сообществ);
  - unanswered — беседы, помеченные как неотвеченные(только для сообществ);
- $params - массив доп параметров для метода messages.send. Прим: [‘attachment’ => ‘wall_-123_123’]
```
$keyboard = $vk->generateKeyboard([[$location],[$pay]], true);
$vk->sendAllDialogs($message, $keyboard); `
```
sendAllChats($message, $params = []) - Отправляет сообщение в чаты пользователя или в чаты, куда пригласили бота группы
- $params - массив доп параметров для метода messages.send. Прим: [‘attachment’ => ‘wall_-123_123’]
isAdmin($id, $chat_id) - проверяет, является ли $id админом в беседе $chat_id. Если пользователя ,нет в беседе или нет админ прав, то вылетит exception, советую сделать try catch для этой команды
- $id - id пользователя
- $chat_id - id чата
Может вернуть следущие значения:
- owner - создатель
- admin - админ
- false - пользователь
- null - пользователя нет в беседе
setTryCountResendFile($var) - задаёт максимальное количество попыток загрузки файла
- У vk, бывает, с этим возникают некоторые баги и файл не загружается
- $var - число попыток, по умолчанию 5, также можно настроить число по умолчанию в файле конфигурации
setRequestIgnoreError($var) - задаёт коды ошибок vk, при которых сообщение об ошибке игнорируется и отправляется повторный запрос
- Внимание! запрос будет отправляться бесконечно, пока не получит от api vk ответ об успешном выполнении!
- $var - массив кодов ошибок, по умолчанию [6,9,14], также можно настроить число по умолчанию в файле конфигурации

Класс LongPoll

Класс позволяет работать с LongPoll

Подключение

require_once('vendor/autoload.php'); //подключаем библу
use DigitalStar\vk_api\vk_api;
use DigitalStar\vk_api\LongPoll;

Получения событий в группе

$vk = vk_api::create(TOKEN, '5.95');
$vk = new LongPoll($vk);

$vk->listen(function($data)use($vk){ //в $data содержится все данные события, можно убрать, если не нужен
    $vk->initVars($id, $message);
    $vk->reply($message);
});

Получение событий пользователя

$vk = vk_api::create('login', 'password', '5.95');
$vk = new LongPoll($vk);

$vk->listen(function()use($vk){ //longpoll для пользователя
    $vk->on('new_message', function($data)use($vk) {
        $vk->initVars($id, $message);
        $vk->reply($message);
    });
});

Методы класса

Все методы vk_api

Класс Execute

Подключение

require_once('vendor/autoload.php'); //подключаем библу
use DigitalStar\vk_api\vk_api;
use DigitalStar\vk_api\Execute;

Инициализация класса

$vk = new Execute($vk);

При использовании вместе с LongPoll следует передать этот объект при инициализации LongPoll

Поддерживаемые методы

reply($message, $params = []) - отправка сообщения тому, от кого пришел callback(личка пользователя или беседа)
sendMessage($id, $message, $params = []) - отправка сообщения
sendButton($id, $message, $buttons = [], $inline = false, $one_time = False, $params = []) - отправка клавиатуры
Полная поддержка конструктора сообщений, если инициализировать конструктор от данного экземпляра

Также будут работать все методы класса vk_api, но в обычном режиме, а не в режиме Execute

Специальные методы

exec() - выполняет все накопленные методы (максимум 25)

При использовании Execute, запросы к api vk накапливаются в памяти, как только количество запросов достигнет 25, они отправятся одним запросом на api vk, так же запросы отправляются при вызове деструктора экземпляра Execute (при завершении скрипта или функции, где он был инициализирован). Также можно запросить отправку вручную (если запросов < 25), с помощью метода exec()

При использовании LongPoll вместе с Execute, метод exec() вызывается автоматически после обработки каждой ‘пачки’ полученных данных

При испоьзовании Callback exec() вызывается автоматически при завершении скрипта

Примеры использования

Класс Coin

Подключение

require_once('vendor/autoload.php'); //подключаем библу
use DigitalStar\vk_api\vk_api;
use DigitalStar\vk_api\Coin;

Инициализация класса

$coin = new Coin(COIN_API_KEY, COIN_API_ID);
или
$сoin = Coin::create(COIN_API_KEY, COIN_API_ID);
- COIN_API_KEY - Ключ вашего магазина
- COIN_API_ID - идентификатор владельца магазина.

Методы класса

sendCoins($user_id, $amount) - отправка платежа.

ВНИМАНИЕ, 1 единица = 1 coin. Если вы хотите отправить меньше одного коина, то пишите 0.001

getBalance($user_ids = []) - получение баланса. Можно передать id или массив id. Если не задан $user_ids, вернет баланс магазина.
setName($name) - установка имени магазина.
setCallBack($url = null) - Установка callBack-сервера для примема платежей через специальную ссылку.
deleteCallBack() - удаление callBack-сервера.
getLogs() - получение списка ошибок и изменений в настройках callBack.
verifyKeys($data) - Сверка ключей callBack. Вернет true или false
getLink($sum = 0, $fixed_sum = true, $payload = 0, $to_hex = false) - Получение платежной ссылки.
- $sum - сумма
- $fixed_sum - Не дает возмоджности изменить сумму. Принимает true/false
- $payload - полезная нагрузка для ссылки. Принимает int значение
- $to_hex - кодирует в hex вид ссылку. Сделана скорее для скрытия данных от школьников. Если true - может не работать проверка ключей.
Вернет массив [‘url’ => …, ‘payload’ => …]. Для получения ссылки пишите getLink(…)[‘url’]
getStoryShop($last_tx) - получить 100 последних транзакций на аккаунт
- $last_tx - id транзакции, после которой будут браться 100 следующих транзакций
getStoryAccount($last_tx) - получить 1000 последних транзакций по генерированных ссылкам функцией getLink
- $last_tx - id транзакции, после которой будут браться 1000 следующих транзакций
getInfoTransactions($id_transactions) - получить информацию о транзакциях. Принимает 1 id или массив id
initVars($from_id, $amount, $payload, $verify, $data) - инициализирует переменные, которые есть в callback транзакции
- $data - здесь находится все данные калбэка. На случай, если вам нужны переменные которые не задаются в функции
- $verify - содержит true или false. Защита, если кто-то вдруг найдет путь до вашего callback скрипта

Примеры использования

Класс Group

Класс позволяет работать с группами от имени пользователя (используя токен доступа пользователя)

Инициализация класса

$my_group = new group('id группы', 'экземпляр класса vk_api')

Методы класса

Все методы vk_api, которые можно использовать с ключом доступа сообщества

Класс Auth

Класс нужен для кастомной авторизации в vk, можно задать множество параметров при авторизации и выбрать метод авторизации, также получить токен доступа или куки

Инициализация класса

$my_auth = new Auth('логин', 'пароль', $other = null, $mobile = true) - авторизация через логин и пароль
- Это инициализация по умолчанию при авторизации через логин/пароль в vk_api
- $mobile - выбор метода авторизации (true - будет использоваться штатная авторизация под видом мобильного приложения, false - авторизация через приложение vk)
$my_auth = new Auth('куки', null, $other = null) - авторизация через куки
- куки - массив в json с куками
- Работает только если куки были получены на том же сервере (с тем же ip), с которого происходит авторизация
- Рекомендуется использовать куки, полученный при вызове метода dumpCookie()
- Авторизацию через куки можно использовать, только если куки были получены при авторизации через приложение VK!

$other - массив для изменения значений по умолчанию
может принимать значения: ['useragent' => 'пользовательский User-Agent', 'id_app' => 'id приложения для авторизации через приложение vk'] 
Причём как что-то одно, так и все сразу
Значения по умолчанию useragent и id_app можно также изменить в файле конфигурации

Как показала практика, авторизация через приложение vk может по непонятным причинам забагаваться для аккаунта, решение пока не найдено, и непонятно что на это влияет.

Штатная авторизация под видом мобильного приложения самая надёжная и работает всегда. Рекомендуется использовать именно её

Методы класса

auth() - запускает процесс авторизации (ТОЛЬКО ДЛЯ АВТОРИЗАЦИИ ЧЕРЕЗ ПРИЛОЖЕНИЕ vk)
- После вызова метода происходит авторизация в vk (получение авторизационнах кук), но не получение токена доступа. (Смысл авторизации под видом мобильного приложения заключается в получении токена доступа, по этому метод auth() бессмысленен для метода авторизации через мобильное приложение)
dumpCookie() - возвращает текущие куки в формате JSON
isAuth() - проверяет, выполнена ли авторизация вернёт true или false
getAccessToken($captcha_key = null, $captcha_sid = null) - попытаться получить токен доступа, при успехе его и вернёт
- Параметры не работают при авторизации через приложение VK
- $captcha_key - решение каптчи
- $captcha_sid - сид каптчи, полученный при ошибки (VkApiException, можно поймать через try catch вместе со ссылкой на картинку каптчи) если при предыдущей попытке авторизации вылетала каптча

Класс Post

Этот класс является удобным конструктором запросов для создания и публикации постов

Инициализация класса

$new_post = new Post('экземпляр класса vk_api')

Методы класса

setMessage($message) - задаёт текст
addImage($images1, $images2,...) - добавляет картинки во вложения
- Может принимать как 1 параметр (массив из ссылок на файлы), так и 1 или больше отдельных параметров (строк - ссылок на файлы)
addProp($prop, $value) - задаёт дополнительный(пользовательский) параметр в запросе к api
- $prop - название параметра
- $value - значение
addDocs($docs, $title = null) - добавляет документы во вложения
- Может работать двумя способами:
  - Принимать $docs - путь до файла и $title - новое название файла, если нужно изменить
  - Принимать массив: [['path' => 'путь', 'title' => 'название'], ['path' => 'путь', 'title' => null],...]
removeImages($images) - удаляет из вложений картинку с путём $images
removeDocs($docs) - удаляет из вложений документ с путём $docs
removeProp($prop) - удаляет пользовательский параметр $prop
getMedia() - возвращает весь массив вложений
getMessage() - возвращает заданное сообщение
getProps() - возвращает пользовательские параметры
send($id, $publish_date = null) - публикует пост, возвращает id поста после публикации
- $id - id пользователя или сообщества (если сообщества, то с минусом), на стену которого будет опубликован пост
- $publish_date - дата в формате Unixtime, когда будет опубликована запись (опубликуется в отложенные до этого времени). Если не задать, опубликуетс сразу же

Максимальное количество вложений - 10. Это ограничение самого VK, при превышении сгенерируется исключение

Также метод send() можно вызывать сколько угодно раз с разными параметрами, для публикации одного и того же поста в разных местах

При вызове нескольких методов подряд с префиксом add или remove, они будут дополнять друг друга, а не заменять

Класс Message

Этот класс является удобным конструктором запросов для создания и отпраvkи сообщений

Инициализация класса

$new_message = new Message($vk)
- $vk - экземпляр класса vk_api или group, при инициализации в группе с ключем пользователя

Методы класса

Все те же, что и у класса Post, только send() слегка другой и есть дополнительные

setKeyboard($keyboard = [], $inline = false, $one_time = false) - прикрепляет клавиатуру к сообщению (только если отпровитель - бот)
- $keyboard - массив клавиатуры
- $one_time - исчезнет ли клавиатура после того, как пользователь ей воспользуется?
- $inline - inline клавиатура?
- В целом, работает так же, как и sendButton()
getKeyboard() - возвращает настройки прикреплённой клавиатуры
addVoice($local_file_path) - прикрепляет голосовое сообщение
- $local_file_path - путь до медиафайла. Поддерживаемые форматы: |.mp3|.ogg|.pcm|.wav|
send($id) - отправляет сообщение
- $id - $id адресата сообщения

# Доступные классы

# Класс vk_api

# Инициализация класса

# Методы класса

# Класс LongPoll

# Подключение

# Получения событий в группе

# Получение событий пользователя

# Методы класса

# Класс Execute

# Подключение

# Инициализация класса

# Поддерживаемые методы

# Специальные методы

# Примеры использования

# Класс Coin

# Подключение

# Инициализация класса

# Методы класса

# Примеры использования

# Класс Group

# Инициализация класса

# Методы класса

# Класс Auth

# Инициализация класса

# Методы класса

# Класс Post

# Инициализация класса

# Методы класса

# Класс Message

# Инициализация класса

# Методы класса

Доступные классы

Класс vk_api

Инициализация класса

Методы класса

Класс LongPoll

Подключение

Получения событий в группе

Получение событий пользователя

Методы класса

Класс Execute

Подключение

Инициализация класса

Поддерживаемые методы

Специальные методы

Примеры использования

Класс Coin

Подключение

Инициализация класса

Методы класса

Примеры использования

Класс Group

Инициализация класса

Методы класса

Класс Auth

Инициализация класса

Методы класса

Класс Post

Инициализация класса

Методы класса

Класс Message

Инициализация класса

Методы класса