Описание класса VkRequest | Universal Bot

VkRequest
in

Класс отвечающий за отправку запросов на Vk сервер.

Документация по ВК api.

Table of Contents

VK_API_VERSION '5.103'
VK_API_ENDPOINT 'https://api.vk.ru/method/'
$vkApiVersion Используемая версия Api. string
$request Отправка запросов. Request
$error Текст ошибки. string|null
$token Vk токен, необходимый для отправки запросов на сервер. string|null
$isAttachContent Тип контента файла. bool
__construct() VkRequest constructor. mixed
initToken() Установить vk токен. void
call() Вызов методов vk. array|null
upload() Загрузка файлов на vk сервер. array|null
messagesSend() Отправка сообщения пользователю. array|int|null
usersGet() Получение данные о пользователе. array|null
photosGetMessagesUploadServer() Получение данные по загрузке изображения на vk сервер. array|null
photosSaveMessagesPhoto() Сохранение файла на vk сервер. array|null
docsGetMessagesUploadServer() Получение данные по загрузке файла на vk сервер. array|null
docsSave() Загрузка файла на vk сервер. array|null
log() Сохранение логов. void

Constants

VK_API_VERSION

mixed $VK_API_VERSION = '5.103'

VK_API_ENDPOINT

mixed $VK_API_ENDPOINT = 'https://api.vk.ru/method/'

Properties

$vkApiVersion

Используемая версия Api.

protected string $vkApiVersion

$error

Текст ошибки.

protected string|null $error

$token

Vk токен, необходимый для отправки запросов на сервер.

public string|null $token

$isAttachContent

Тип контента файла.

public bool $isAttachContent
True если передается содержимое файла. По умолчанию: false.

Methods

__construct()

VkRequest constructor.

public __construct( ) : mixed
Return values
mixed

initToken()

Установить vk токен.

public initToken( $token : string ) : void
Parameters
$token : string

Токен для загрузки данных на сервер.

Tags
api

call()

Вызов методов vk.

public call( $method : string ) : array|null
Parameters
$method : string

Название метода.

Tags
api
throws
Return values
array|null

upload()

Загрузка файлов на vk сервер.

public upload( $url : string , $file : string ) : array|null
Parameters
$url : string

Адрес, на который отправляется запрос.

$file : string

Загружаемый файл(ссылка или содержимое файла).

Tags
api
throws
Return values
array|null —

[

  • 'photo' => array
  • 'server' => string
  • 'hash' => string ] or [
  • 'file' => array ]

messagesSend()

Отправка сообщения пользователю.

public messagesSend( $peerId : string|int , $message : string [, $params : array = [] ] ) : array|int|null
Parameters
$peerId : string|int

Идентификатор места назначения.

$message : string

Текст сообщения.

$params : array = []

Пользовательские параметры: [

  • integer user_id: User ID (by default — current user).
  • integer random_id: Unique identifier to avoid resending the message.
  • integer peer_id: Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. ".
  • string domain: User's short address (for example, 'illarionov').
  • integer chat_id: ID of conversation the message will relate to.
  • array[integer] user_ids: IDs of message recipients (if new conversation shall be started).
  • string message: (Required if 'attachments' is not set.) Text of the message.
  • number lat: Geographical latitude of a check-in, in degrees (from -90 to 90).
  • number long: Geographical longitude of a check-in, in degrees (from -180 to 180).
  • string attachment: (Required if 'message' is not set.) List of objects attached to the message, separated by commas, in the following format: "_", '' — Type of media attachment: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, 'wall' — wall post, '' — ID of the media attachment owner. '' — media attachment ID. Example: "photo100172_166443618".
  • integer reply_to.
  • array[integer] forward_messages: ID of forwarded messages, separated with a comma. Listed messages of the sender will be shown in the message body at the recipient's. Example: "123,431,544".
  • string forward.
  • integer sticker_id: Sticker id.
  • integer group_id: Group ID (for group messages with group access token).
  • string keyboard.
  • string payload.
  • boolean dont_parse_links.
  • boolean disable_mentions. ]
Tags
api
throws
Return values
array|int|null —
  • int: response or in user_ids [[
    • 'peer_id' => int Идентификатор назначения
    • 'message_id' => int Идентификатор сообщения
    • 'error' => array ]]

usersGet()

Получение данные о пользователе.

public usersGet( $userId : array|string|int [, $params : array = [] ] ) : array|null
Parameters
$userId : array|string|int

Идентификатор пользователя.

$params : array = []

Пользовательские параметры: [

  • array[string] user_ids: User IDs or screen names ('screen_name'). By default, current user ID.
  • array fields: Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'contacts', 'education', 'online', 'counters', 'relation', 'last_seen', 'activity', 'can_write_private_message', 'can_see_all_posts', 'can_post', 'universities'.
  • string name_case: Case for declension of user name and surname: 'nom' — nominative (default), 'gen' — genitive , 'dat' — dative, 'acc' — accusative , 'ins' — instrumental , 'abl' — prepositional. ]
Tags
api
throws
Return values
array|null —

[

  • 'id' => int Идентификатор пользователя
  • 'first_name' => string Имя пользователя
  • 'last_name' => string Фамилия пользователя
  • 'deactivated' => string Возвращается, если страница удалена или заблокирована
  • 'is_closed' => bool Скрыт ли профиль настройками приватности
  • 'can_access_closed' => bool Может ли текущий пользователь видеть профиль при is_closed = 1 (например, он есть в друзьях). ]

photosGetMessagesUploadServer()

Получение данные по загрузке изображения на vk сервер.

public photosGetMessagesUploadServer( $peerId : string|int ) : array|null
Parameters
$peerId : string|int

Идентификатор места назначения.

Tags
api
throws
Return values
array|null —

[

  • 'upload_url' => string Адрес сервера для загрузки изображения
  • 'album_id' => int Идентификатор альбома
  • 'group_id' => int Идентификатор сообщества ]

photosSaveMessagesPhoto()

Сохранение файла на vk сервер.

public photosSaveMessagesPhoto( $photo : string , $server : string , $hash : string ) : array|null
Parameters
$photo : string

Фотография.

$server : string

Сервер.

$hash : string

Хэш.

Tags
see

Смотри тут

api
throws
Return values
array|null —

[

  • 'id' => int Идентификатор изображения
  • 'pid' => int
  • 'aid' => int
  • 'owner_id' => int Идентификатор пользователя, загрузившего изображение
  • 'src' => string Расположение изображения
  • 'src_big' => string Расположение большой версии изображения
  • 'src_small' => string Расположение маленькой версии изображения
  • 'created' => int Дата загрузки изображения в unix time
  • 'src_xbig' => string Для изображений с большим разрешением
  • 'src_xxbig' => string Для изображений с большим разрешением ]

docsGetMessagesUploadServer()

Получение данные по загрузке файла на vk сервер.

public docsGetMessagesUploadServer( $peerId : string|int , $type : string ) : array|null
Parameters
$peerId : string|int

Идентификатор места назначения.

$type : string

('doc' - Обычный документ, 'audio_message' - Голосовое сообщение, 'graffiti' - Граффити).

Tags
api
throws
Return values
array|null —

[

  • 'upload_url' => url Адрес сервера для загрузки документа ]

docsSave()

Загрузка файла на vk сервер.

public docsSave( $file : string , $title : string [, $tags : string|null = null ] ) : array|null
Parameters
$file : string

Сам файл.

$title : string

Заголовок файла.

$tags : string|null = null

Теги, по которым будет осуществляться поиск.

Tags
api
throws
Return values
array|null —

[

  • 'type' => string Тип загруженного документа
  • 'graffiti' => [
    • 'id' => int Идентификатор документа
    • 'owner_id' => int Идентификатор пользователя, загрузившего документ
    • 'url' => string Адрес документа, по которому его можно загрузить
    • 'width' => int Ширина изображения в px
    • 'height' => int Высота изображения в px ] or
  • 'audio_message' => [
    • 'id' => int Идентификатор документа
    • 'owner_id' => int Идентификатор пользователя, загрузившего документ
    • 'duration' => int Длительность аудио сообщения в секундах
    • 'waveform' => int[] Массив значений для визуального отображения звука
    • 'link_ogg' => url .ogg файла
    • 'link_mp3' => url .mp3 файла ] or
  • 'doc' =>[
    • 'id' => int Идентификатор документа
    • 'owner_id' => int Идентификатор пользователя, загрузившего документ
    • 'url' => string Адрес документа, по которому его можно загрузить
    • 'title' => string Название документа
    • 'size' => int Размер документа в байтах
    • 'ext' => string Расширение документа
    • 'date' => int Дата добавления в формате unix time
    • 'type' => int Тип документа. (1 - текстовый документ; 2 - архивы; 3 - gif; 4 - изображения; 5 - аудио; 6 - видео; 7 - электронные книги; 8 - неизвестно)
    • 'preview' => [ Информация для предварительного просмотра документа.
      • 'photo' => [Изображения для предпросмотра.
        • 'sizes' => array Массив копий изображения в разных размерах. Подробное описание структуры (https://vk.ru/dev/objects/photo_sizes) ] or
      • 'graffiti' => [ Данные о граффити
        • 'src' => string url Документа с граффити
        • 'width' => int Ширина изображения в px
        • 'height' => int Высота изображения в px ] or
      • 'audio_message' => [ Данные об аудиосообщении
        • 'duration' => int Длительность аудио сообщения в секундах
        • 'waveform' => int[] Массив значений для визуального отображения звука
        • 'link_ogg' => url .ogg файла
        • 'link_mp3' => url .mp3 файла ] ] ]
  • 'id' => int Идентификатор документа
  • 'owner_id' => int Идентификатор пользователя, загрузившего документ
  • 'url' => string Адрес документа, по которому его можно загрузить (Для граффити и документа)
  • 'width' => int Ширина изображения в px (Для граффити)
  • 'height' => int Высота изображения в px (Для граффити)
  • 'duration' => int Длительность аудио сообщения в секундах(Для Голосового сообщения)
  • 'waleform' => int[] Массив значений для визуального отображения звука(Для Голосового сообщения)
  • 'link_ogg' => url .ogg файла(Для Голосового сообщения)
  • 'link_mp3' => url .mp3 файла(Для Голосового сообщения) ]

log()

Сохранение логов.

protected log( $error : string ) : void
Parameters
$error : string

Текст ошибки.

Tags
throws

Search results