8 Commits
4.0.1 ... 4.0.x

10 changed files with 906 additions and 225 deletions

4
.gitignore vendored
View File

@@ -1 +1,3 @@
/vendor
!.gitignore
composer.phar
vendor

View File

@@ -1,5 +1,5 @@
# Колпачный фреймворк для ВКонтакте
Развивается как многопоточный фреймворк с поддержкой всех возможностей API ВКонтакте, а так же не добавленных, но необходимых функций, работу с большим количеством роботов под разными сессиями, поддерживающий PSR-спецификацию и полностью покрытый тестами
# PHP-фреймворк ВКонтакте
Многопоточный фреймворк с поддержкой всех возможностей API ВКонтакте
### Установка:
```sh

View File

@@ -1,35 +1,39 @@
{
"name": "mirzaev/vk",
"type": "framework",
"description": "Фреймворк VK API",
"description": "Framework for vk.com API",
"readme": "README.md",
"keywords": [
"vk",
"api"
],
"homepage": "https://git.hood.su/mirzaev/vk",
"homepage": "https://git.mirzaev.sexy/mirzaev/vk",
"license": "WTFPL",
"authors": [
{
"name": "Arsen Mirzaev Tatyano-Muradovich",
"email": "arsen@mirzaev.sexy",
"homepage": "https://hood.su/mirzaev",
"homepage": "https://mirzaev.sexy/mirzaev",
"role": "Programmer"
}
],
"support": {
"docs": "https://git.hood.su/mirzaev/vk/manual",
"issues": "https://git.hood.su/mirzaev/vk/issues"
"docs": "https://git.mirzaev.sexy/mirzaev/vk/wiki",
"issues": "https://git.mirzaev.sexy/mirzaev/vk/issues"
},
"require": {
"php": "~8.1",
"psr/log": "~1.0",
"mirzaev/accounts": "~1.2.x-dev",
"monolog/monolog": "~1.6",
"jasny/error-handler": "~0.2",
"guzzlehttp/guzzle": "~7.5"
"php": "^8.1",
"psr/log": "^1.0",
"mirzaev/accounts": "^1.2.0",
"monolog/monolog": "^1.6",
"jasny/error-handler": "^0.2",
"guzzlehttp/guzzle": "^7.5"
},
"require-dev": {
"phpunit/phpunit": "~9.5"
"phpunit/phpunit": "^9.5"
},
"suggest": {
"ext-sodium": "Can be selected in some conditions to increase security"
},
"autoload": {
"psr-4": {

View File

@@ -0,0 +1,115 @@
<?php
declare(strict_types=1);
namespace mirzaev\vk\api\methods;
// Файлы проекта
use mirzaev\vk\robots\user;
// Встроенные библиотеки
use Exception;
/**
* Аккаунт
*
* @method public getInfo(?array $fields = null) Запросить информацию об аккаунте
* @method public getProfileInfo(?array $fields = null) Запросить информацию о профиле
*
* @see https://dev.vk.com/method/account
*
* @package mirzaev\vk\api
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
final class account extends method
{
/**
* Конструктор
*
* @param user $user Робот
*/
public function __construct(
protected user $robot
) {
}
/**
* Запросить информацию об аккаунте
*
* @see https://dev.vk.com/method/account.getInfo
*
* @param array $fields Выбор полей с запрашиваемой информацией (оставить пустым, если нужны все)
*
* @return ?array Информация об аккаунте, если получена
*
* @todo
* 1. Доделать
* 2. Написать обработчик ошибок возвращаемых ВКонтакте
*/
public function getInfo(array $fields = []): array
{
// Реиницилазиция
$this->robot->api->reinit();
foreach ($fields as $key => $field) {
// Перебор запрашиваемых полей с информацией
// Запись запрашиваемого поля
$this->robot->api['fields'] .= $field;
// Запись разделителя
if ($key === array_key_last($fields)) break;
else $this->robot->api['fields'] .= ', ';
}
// Запрос
$request = json_decode($this->robot->browser->request('POST', 'account.getInfo', ['form_params' => $this->robot->api->settings])->getBody()->getContents());
// Если в ответе ошибка
if (isset($request->error)) {
throw new Exception('ВКонтакте: ' . $request->error->error_msg, $request->error->error_code);
}
return $request->response;
}
/**
* Запросить информацию о профиле
*
* @see https://dev.vk.com/method/account.getProfileInfo
*
* @param array $fields Выбор полей с запрашиваемой информацией (оставить пустым, если нужны все)
*
* @return ?array Информация об аккаунте, если получена
*
* @todo
* 1. Доделать
* 2. Написать обработчик ошибок возвращаемых ВКонтакте
*/
public function getProfileInfo(array $fields = []): array
{
// Реиницилазиция
$this->robot->api->reinit();
foreach ($fields as $key => $field) {
// Перебор запрашиваемых полей с информацией
// Запись запрашиваемого поля
$this->robot->api['fields'] .= $field;
// Запись разделителя
if ($key === array_key_last($fields)) break;
else $this->robot->api['fields'] .= ', ';
}
// Запрос
$request = json_decode($this->robot->browser->request('POST', 'account.getProfileInfo', ['form_params' => $this->robot->api->settings])->getBody()->getContents());
// Если в ответе ошибка
if (isset($request->error)) {
throw new Exception('ВКонтакте: ' . $request->error->error_msg, $request->error->error_code);
}
return $request->response;
}
}

View File

@@ -4,23 +4,39 @@ declare(strict_types=1);
namespace mirzaev\vk\api\methods;
use Exception;
// Файлы проекта
use mirzaev\vk\robots\robot,
mirzaev\vk\robots\group;
use mirzaev\accounts\vk;
use mirzaev\vk\robots\robot;
use mirzaev\vk\api\data;
use mirzaev\vk\robots\group;
// Встроенные библиотеки
use stdClass,
Exception;
/**
* Режимы отправки сообщений
*/
enum mode
enum message_send
{
/** Быстро - случайный идентификатор (умножение на rand()) */
/** Обычная отправка */
case simple;
/** Проверка отправки */
case check;
}
/**
* Режимы генерации идентификатора сессии доставки сообщения
*/
enum random_id
{
/** Генерация: time() (нельзя отправить более чем 1 сообщение в секунду) */
case date;
/** Генерация: rand() */
case random;
/** Надёжно - проверка отправки (поиск сообщения через messages.getById) */
case search;
/** Генерация: random_int(0, PHP_INT_MAX) */
case crypto;
}
/**
@@ -39,78 +55,397 @@ enum mode
final class messages extends method
{
/**
* @var mode $mode Режим отправки сообщений
* @var message_send $send_mode Режим отправки сообщений
*/
protected mode $mode = mode::random;
protected message_send $send_mode = message_send::simple;
/**
* @var array[int] Сообщения для пересылки
* @var random_id $generate_mode Режим генерации идентификатора сессии доставки сообщения
*/
protected array $forward;
protected random_id $generate_mode = random_id::crypto;
/**
* @var int Сообщение для ответа
* @var int|string|array|null $destination Получатель
*/
protected int $reply;
protected int|string|array|null $destination = null;
/**
* @var string|null $text Текст
*/
protected string|null $text = null;
/**
* @var ?int $lat Географическая ширина
*/
protected ?int $lat = null;
/**
* @var ?int $long Географическая долгота
*/
protected ?int $long = null;
/**
* @var ?int $reply_to Идентификатор сообщения, на которое требуется ответить
*/
protected ?int $reply_to = null;
/**
* @var ?array $forward_messages Идентификаторы пересылаемых сообщений
*/
protected ?array $forward_messages = null;
/**
* @var ?string $sticker_id Идентификатор стикера
*/
protected ?string $sticker_id = null;
/**
* @var ?string $payload Полезная нагрузка
*/
protected ?string $payload = null;
/**
* @var bool $dont_parse_links Не создавать представление ссылки в сообщении?
*/
protected bool $dont_parse_links = false;
/**
* @var bool $disable_mentions Отключить уведомление об упоминании в сообщении?
*/
protected bool $disable_mentions = false;
/**
* @var ?string $intent Интент
*/
protected ?string $intent = null;
/**
* @var ?string $subscribe_id Число, которое будет использоваться для работы с интентами
*/
protected ?int $subscribe_id = null;
/**
* Конструктор
*
* @param robot $robot Робот
*/
public function __construct(protected robot $robot, mixed ...$properties)
{
// Быстрая отправка
if (!empty($properties)) $this->send(...$properties);
}
/**
* Записать: режим отправки сообщений
*
* @param message_send $send_mode Режим отправки сообщений
*
* @return static
*/
public function send_mode(message_send $send_mode): static
{
// Запись в свойство
$this->__set('send_mode', $send_mode);
return $this;
}
/**
* Записать: режим генерации идентификатора сессии доставки сообщения
*
* @param random_id $generate_mode Режим генерации идентификатора сессии доставки сообщения
*
* @return static
*/
public function generate_mode(random_id $generate_mode): static
{
// Запись в свойство
$this->__set('generate_mode', $generate_mode);
return $this;
}
/**
* Записать: получатель
*
* @param int|string|array|null $destination Получатель
*
* @return static
*/
public function destination(int|string|array|null $destination): static
{
// Запись в свойство
$this->__set('destination', $destination);
return $this;
}
/**
* Записать: текст
*
* @param string|null $text Текст
*/
public function __construct(
protected robot $robot,
int|string|array|null $destination = null,
protected string|null $text = null
) {
if (isset($this->text, $destination)) {
// Быстрая отправка
$this->send($destination);
}
}
/**
* Записать текст
*
* @param string $text Текст
* @return static
*/
public function text(string $text): self
public function text(string|null $text): static
{
// Записать текст
if (!isset($this->text)) {
$this->text = $text;
} else {
$this->text .= $text;
}
// Запись в свойство
$this->__set('text', $text);
return $this;
}
/**
* Записать сообщения для пересылки
* Записать: географическая ширина
*
* @param $ids Идентификаторы сообщений
* @param ?int $lat Географическая ширина
*
* @return static
*/
public function forward(...$ids): self
public function lat(?int $lat): static
{
// Запись
$this->forward = array_merge($this->forward ?? [], $ids);
// Запись в свойство
$this->__set('lat', $lat);
return $this;
}
/**
* Записать сообщение для ответа
* Записать: географическая долгота
*
* @param $id Идентификатор сообщения
* @param ?int $long Географическая долгота
*
* @return static
*/
public function reply(int $id): self
public function long(?int $long): static
{
// Запись
$this->reply = $id;
// Запись в свойство
$this->__set('long', $long);
return $this;
}
/**
* Записать: идентификатор сообщения, на которое требуется ответить
*
* @param ?int $reply_to Идентификатор сообщения, на которое требуется ответить
*
* @return static
*/
public function reply_to(?int $reply_to): static
{
// Запись в свойство
$this->__set('reply_to', $reply_to);
return $this;
}
/**
* Записать: идентификатор сообщения, на которое требуется ответить
*
* @param ?int $reply Идентификатор сообщения, на которое требуется ответить
*
* @return static
*/
public function reply(?int $reply): static
{
// Запись в свойство
$this->__set('reply_to', $reply);
return $this;
}
/**
* Записать: идентификатор сообщения, на которое требуется ответить
*
* @param ?int $to Идентификатор сообщения, на которое требуется ответить
*
* @return static
*/
public function to(?int $to): static
{
// Запись в свойство
$this->__set('reply_to', $to);
return $this;
}
/**
* Записать: идентификаторы пересылаемых сообщений
*
* @param ?array $forward_messages Идентификаторы пересылаемых сообщений
*
* @return static
*/
public function forward_messages(?array $forward_messages): static
{
// Запись в свойство
$this->__set('forward_messages', $forward_messages);
return $this;
}
/**
* Записать: идентификаторы пересылаемых сообщений
*
* @param ?array $forward Идентификаторы пересылаемых сообщений
*
* @return static
*/
public function forward(?array $forward): static
{
// Запись в свойство
$this->__set('forward_messages', $forward);
return $this;
}
/**
* Записать: идентификатор стикера
*
* @param ?string $sticker_id Идентификатор стикера
*
* @return static
*/
public function sticker_id(?string $sticker_id): static
{
// Запись в свойство
$this->__set('sticker_id', $sticker_id);
return $this;
}
/**
* Записать: идентификатор стикера
*
* @param ?string $sticker Идентификатор стикера
*
* @return static
*/
public function sticker(?string $sticker): static
{
// Запись в свойство
$this->__set('sticker_id', $sticker);
return $this;
}
/**
* Записать: полезная нагрузка
*
* @param ?string $payload Полезная нагрузка
*
* @return static
*/
public function payload(?string $payload): static
{
// Запись в свойство
$this->__set('payload', $payload);
return $this;
}
/**
* Записать: не создавать представление ссылки в сообщении?
*
* @param bool $dont_parse_links Не создавать представление ссылки в сообщении?
*
* @return static
*/
public function dont_parse_links(bool $dont_parse_links): static
{
// Запись в свойство
$this->__set('dont_parse_links', $dont_parse_links);
return $this;
}
/**
* Записать: создавать представление ссылки в сообщении?
*
* @param bool $payload Cоздавать представление ссылки в сообщении?
*
* @return static
*/
public function links(bool $links): static
{
// Запись в свойство
$this->__set('dont_parse_links', !$links);
return $this;
}
/**
* Записать: отключить уведомление об упоминании в сообщении?
*
* @param bool $disable_mentions Отключить уведомление об упоминании в сообщении?
*
* @return static
*/
public function disable_mentions(bool $disable_mentions): static
{
// Запись в свойство
$this->__set('disable_mentions', $disable_mentions);
return $this;
}
/**
* Записать: включить уведомление об упоминании в сообщении?
*
* @param bool $mentions Включить уведомление об упоминании в сообщении?
*
* @return static
*/
public function mentions(bool $mentions): static
{
// Запись в свойство
$this->__set('disable_mentions', !$mentions);
return $this;
}
/**
* Записать: интент
*
* @param ?string $intent Интент
*
* @return static
*/
public function intent(?string $intent): static
{
// Запись в свойство
$this->__set('intent', $intent);
return $this;
}
/**
* Записать: число, которое будет использоваться для работы с интентами
*
* @param ?int $subscribe_id Число, которое будет использоваться для работы с интентами
*
* @return static
*/
public function subscribe_id(?int $subscribe_id): static
{
// Запись в свойство
$this->__set('subscribe_id', $subscribe_id);
return $this;
}
/**
* Записать: число, которое будет использоваться для работы с интентами
*
* @param ?int $subscribe Число, которое будет использоваться для работы с интентами
*
* @return static
*/
public function subscribe(?int $subscribe): static
{
// Запись в свойство
$this->__set('subscribe_id', $subscribe);
return $this;
}
@@ -120,65 +455,132 @@ final class messages extends method
*
* @see https://vk.com/dev/messages.send
*
* @param int|string|array|null $destination Получатель
* @param int|string|null $destination Получатель
* @param ?string $message Сообщение
* @param ?int $lat Географическая ширина
* @param ?int $long Географическая долгота
* @param ?array $attachments Вложения
* @param ?int $reply_to Идентификатор сообщения, на которое требуется ответить
* @param ?array $forward_messages Идентификаторы пересылаемых сообщений
* @param ?forward $forward Пересылаемые сообщения (в другой чат)
* @param ?string $sticker_id Идентификатор стикера
* @param ?keyboard $keyboard Инстанция клавиатуры
* @param ?template $template Инстанция шаблона сообщения
* @param ?string $payload Полезная нагрузка
* @param bool $dont_parse_links Не создавать представление ссылки в сообщении?
* @param bool $disable_mentions Отключить уведомление об упоминании в сообщении?
* @param ?string $intent Интент
* @param ?int $subscribe_id Число, которое будет использоваться для работы с интентами
* @param ?int $random_id Идентификатор сессии доставки сообщения (защита от повторных отправок)
*
* @return int|array Идентификатор успешно отправленного сообщения или ответ сервера (подразумевается ошибка)
*
* @todo Написать обработчик ошибок возвращаемых ВКонтакте
* @todo
* 1. Написать обработчик ошибок возвращаемых ВКонтакте
* 2. Добавить параметр forward (не путать с forward_messages)
* 3. Добавить клавиатуру
* 4. Добавить шаблоны сообщений
* 5. Добавить content_source
*/
public function send(int|string|array|null $destination): int|array
{
// Идентификатор
$random_id = time();
if ($this->mode === mode::random) {
// Быстрая отправка сообщения
$random_id *= rand();
}
// Реиницилазиция
public function send(
int|string|null $destination = null,
?string $message = null,
?int $lat = null,
?int $long = null,
?array $attachments = null,
?int $reply_to = null,
?array $forward_messages = null,
// ?forward $forward = null,
?string $sticker_id = null,
// ?keyboard $keyboard = null,
// ?template $template = null,
?string $payload = null,
bool $dont_parse_links = false,
bool $disable_mentions = false,
?string $intent = null,
?int $subscribe_id = null,
?int $random_id = null,
): int|array {
// Реинициализация настроек
$this->robot->api->reinit();
// Цель отправки
$this->robot->api->destination($destination);
// Инициализация получателя
if (isset($destination)) $this->destination = $destination;
if (is_int($this->destination)) ($id = $this->destination - 2000000000) > 0 ? $this->robot->api['peer_id'] = $this->destination : $this->robot->api['chat_id'] = $id;
else if (is_array($this->destination)) $this->robot->api['peer_ids'] = implode(',',$this->destination);
else if (is_string($this->destination)) $this->robot->api['domain'] = $this->destination;
// Инициализация идентификатора сообщения (защита от повторных отправок) в настройках API
$this->robot->api['random_id'] = $random_id;
// Инициализация идентификатора сессии доставки сообщения (защита от повторных отправок)
$this->robot->api['random_id'] = $random_id ?? match ($this->generate_mode) {
random_id::date => time(),
random_id::random => rand(),
random_id::crypto => random_int(0, PHP_INT_MAX),
default => random_int(0, PHP_INT_MAX)
};
// Инициализация текста в настройках API
$this->robot->api['message'] = $this->text;
if (isset($message)) $this->text = $message;
if (isset($this->text)) $this->robot->api['message'] = $this->text;
// Пересылаемые сообщения
if (!empty($this->forwardMessages)) {
// Инициализация широты
if (isset($lat)) $this->lat = $lat;
if (isset($this->lat)) $this->robot->api['lat'] = $this->lat;
// Инициализация пересылаемых сообщений в настройках API
$this->robot->api['forward_messages'] = implode(',', $this->forwardMessages);
}
// Инициализация долготы
if (isset($long)) $this->long = $long;
if (isset($this->long)) $this->robot->api['long'] = $this->long;
// Ответные сообщения
if (isset($this->ReplyMessage)) {
// Инициализация вложений
if (isset($attachments)) $this->robot->api->data = $attachments;
if (isset($this->robot->api->data) && $this->robot->api->__get('data') !== []) $this->robot->api['attachment'] = implode(',', $this->robot->api->__get('data'));
// Инициализация идентификатора сообщения на которое обрабатывается ответ в настройках API
$this->robot->api['reply_to'] = $this->ReplyMessage;
}
// Инициализация сообщения, на которое требуется ответить
if (isset($reply_to)) $this->reply = $reply_to;
if (isset($this->reply)) $this->robot->api['reply_to'] = $this->reply;
// Вложения
if (isset($this->data) && $this->__get('data') !== []) { // !empty($this->data->data) почемуто не работает
// Инициализация пересылаемых сообщений
if (isset($forward_messages)) $this->forward_messages = $forward_messages;
if (isset($this->forward_messages)) $this->robot->api['forward_messages'] = implode(',', $this->forward_messages);
// Инициализация вложений в настройках API
$this->robot->api['attachment'] = implode(',', $this->__get('data'));
}
// Инициализация стикера
if (isset($sticker_id)) $this->robot->api['sticker_id'] = $sticker_id;
if (isset($this->sticker_id)) $this->robot->api['sticker_id'] = $this->sticker_id;
// Инициализация полезной нагрузки
if (isset($payload)) $this->payload = $payload;
if (isset($this->payload)) $this->robot->api['payload'] = $this->payload;
// Инициализация пользовательского соглашения
// $this->robot->api['content_source'] = $this->robot->content_source;
// Инициализация "не создавать представление ссылки в сообщении?"
if (isset($dont_parse_links)) $this->dont_parse_links = $dont_parse_links;
if ($this->dont_parse_links) $this->robot->api['dont_parse_links'] = 1;
// Инициализация "отключить уведомление об упоминании в сообщении?"
if (isset($disable_mentions)) $this->disable_mentions = $disable_mentions;
if ($this->disable_mentions) $this->robot->api['disable_mentions'] = 1;
// Инициализация интентов
if (isset($intent)) $this->robot->api['intent'] = $intent;
if (isset($this->intent)) $this->robot->api['intent'] = $this->intent;
// Инициализация числа, которое будет использоваться для работы с интентами
if (isset($subscribe_id)) $this->subscribe_id = $subscribe_id;
if (isset($this->subscribe_id)) $this->robot->api['subscribe_id'] = $this->subscribe_id;
// Проверка сформированного сообщения
if (!$this->robot->api->offsetExists('message') && !$this->robot->api->offsetExists('attachment')) throw new Exception('Сообщение должно содержать текст, либо вложение');
// Запрос
$request = json_decode($this->robot->browser->request('POST', 'messages.send', ['form_params' => $this->robot->api->settings])->getBody()->getContents());
// Если в ответе ошибка
if (isset($request->error)) {
throw new Exception('Вконтакте: ' . $request->error->error_msg, $request->error->error_code);
throw new Exception('ВКонтакте: ' . $request->error->error_msg, $request->error->error_code);
}
if ($this->mode === mode::search) {
if ($this->send_mode === message_send::check) {
// Надёжная доставка сообщения
if (!empty($request["response"])) {
@@ -207,35 +609,56 @@ final class messages extends method
}
/**
* Записать свойство
* Удалить сообщение
*
* @param string $name Название
* @param mixed $value Значение
* @see https://vk.com/dev/messages.delete
*
* @return void
* @param int|string|array|null $messages Получатель (message_ids + cmids)
* @param int|string|null $peer_id Идентификатор беседы
* @param bool $spam Пометить как спам?
* @param bool $delete_for_all Удалить для всех?
*
* @return int|array Идентификатор успешно отправленного сообщения или ответ сервера (подразумевается ошибка)
*
* @todo Написать обработчик ошибок возвращаемых ВКонтакте
*/
public function __set(string $name, mixed $value): void
public function delete(string|int|array|null $messages = null, int|string|null $peer_id = null, bool $spam = false, bool $delete_for_all = false): stdClass
{
match ($name) {
default => throw new Exception("Свойство $name не найдено", 404)
};
}
// Реиницилазиция настроек
$this->robot->api->reinit();
/**
* Прочитать свойство
*
* @param string $name Название
*
* @return mixed
*/
public function __get(string $name): mixed
{
return match ($name) {
'text' => $this->text ?? throw new Exception('Текст не инициализирован'),
'forward' => empty($this->forward) ? throw new Exception('Сообщения для пересылки не инициализированы') : $this->forward,
'reply' => isset($this->reply) ? $this->reply : throw new Exception('Сообщение для ответа не инициализировано'),
default => throw new Exception("Свойство $name не найдено", 404)
};
if (isset($peer_id)) {
// Получен идентификатор беседы
// Инициализация идентификатора беседы
$this->robot->api['peer_id'] = $peer_id;
// Инициализация идентификаторов сообщений
$this->robot->api['cmids'] = $messages;
// Инициализация: "удалить для всех?"
$this->robot->api['delete_for_all'] = 1;
} else {
// Не получен идентификатор беседы
// Инициализация идентификаторов сообщений
$this->robot->api['message_ids'] = $messages;
// Инициализация: "удалить для всех?"
if ($delete_for_all) $this->robot->api['delete_for_all'] = 1;
}
// Инициализация: "сообщить о спаме?"
if ($spam) $this->robot->api['spam'] = $spam;
// Запрос
$request = json_decode($this->robot->browser->request('POST', 'messages.delete', ['form_params' => $this->robot->api->settings])->getBody()->getContents());
// Проверка на наличие ошибок в ответе от ВКонтакте
if (isset($request->error)) throw new Exception('ВКонтакте: ' . $request->error->error_msg, $request->error->error_code);
return $request->response;
}
/**
@@ -275,4 +698,63 @@ final class messages extends method
return $request->response;
}
/**
* Записать свойство
*
* @param string $name Название
* @param mixed $value Значение
*
* @return void
*/
public function __set(string $name, mixed $value): void
{
match ($name) {
'send_mode' => $this->send_mode = $value,
'generate_mode' => $this->generate_mode = $value,
'destination' => $this->destination = $value,
'text' => $this->text = $value,
'lat', 'latitude' => $this->lat = $value,
'long', 'longitude' => $this->long = $value,
'reply_to', 'reply', 'to' => $this->reply_to = $value,
'forward_messages' => $this->forward_messages = $value,
'sticker_id', 'sticker' => $this->sticker_id = $value,
'payload' => $this->payload = $value,
'dont_parse_links' => $this->dont_parse_links = $value,
'parse_links', 'parse' => $this->dont_parse_links = !$value,
'disable_mentions' => $this->disable_mentions = $value,
'mentions' => $this->disable_mentions = !$value,
'intent' => $this->intent = $value,
'subscribe_id' => $this->subscribe_id = $value,
default => throw new Exception("Свойство $name не найдено", 404)
};
}
/**
* Прочитать свойство
*
* @param string $name Название
*
* @return mixed
*/
public function __get(string $name): mixed
{
return match ($name) {
'send_mode' => $this->send_mode,
'generate_mode' => $this->generate_mode,
'destination' => $this->destination,
'text' => $this->text,
'lat', 'latitude' => $this->lat,
'long', 'longitude' => $this->long,
'reply_to', 'reply', 'to' => $this->reply_to,
'forward_messages' => $this->forward_messages,
'sticker_id', 'sticker' => $this->sticker_id,
'payload' => $this->payload,
'dont_parse_links', 'parse_links', 'parse' => $this->dont_parse_links,
'disable_mentions', 'mentions' => $this->disable_mentions,
'intent' => $this->intent,
'subscribe_id' => $this->subscribe_id,
default => throw new Exception("Свойство $name не найдено", 404)
};
}
}

View File

@@ -4,58 +4,12 @@ declare(strict_types=1);
namespace mirzaev\vk\api\methods;
use mirzaev\vk\robots\robot;
/**
* Абстракция метода API
*
* @method protected static put(string $url, ...$params) Создать
* @method protected static post(string $url, ...$params) Изменить
* @method protected static get(string $url, ...$params) Получить
* @method protected static delete(string $url, ...$params) Удалить
* Абстракция метода API ВКонтакте
*
* @package mirzaev\vk\api\methods
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
abstract class method
{
/**
* Создать
*
* @return array Ответ сервера
*/
public static function put(): array
{
return ['error' => 'Метод не поддерживается'];
}
/**
* Изменить
*
* @return array Ответ сервера
*/
public static function post(): array
{
return ['error' => 'Метод не поддерживается'];
}
/**
* Получить
*
* @return array Ответ сервера
*/
public static function get(): array
{
return ['error' => 'Метод не поддерживается'];
}
/**
* Удалить
*
* @return array Ответ сервера
*/
public static function delete(): array
{
return ['error' => 'Метод не поддерживается'];
}
}

View File

@@ -4,12 +4,12 @@ declare(strict_types=1);
namespace mirzaev\vk\api\methods;
use Exception;
// Файлы проекта
use mirzaev\vk\robots\robot,
mirzaev\vk\robots\group;
use mirzaev\accounts\vk as account;
// Встроенные библиотеки
use Exception;
/**
* Фотографии (изображения)
@@ -22,12 +22,12 @@ use mirzaev\accounts\vk as account;
* @package mirzaev\vk\api\methods
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*
* @todo Добавить обработку ошибок ($request['errors];)
* @todo Добавить обработку ошибок ($request['errors])
*/
final class photos extends method
{
/**
* Создать сообщение
* Конструктор
*
* @param robot $robot Робот
*/

View File

@@ -0,0 +1,114 @@
<?php
declare(strict_types=1);
namespace mirzaev\vk\api\methods;
// Файлы проекта
use mirzaev\vk\robots\robot;
// Встроенные библиотеки
use Exception,
stdClass;
/**
* Пользователь
*
*
* @see https://dev.vk.com/method/users
*
* @package mirzaev\vk\api
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
final class users extends method
{
/**
* Конструктор
*
* @param robot $user Робот
*/
public function __construct(
protected robot $robot
) {
}
/**
* Запросить информацию о пользователе
*
* @see https://dev.vk.com/method/users.get
*
* @param array $receiver Выбор пользователей для запроса информации (user_ids)
* @param array $fields Выбор дополнительных запрашиваемых полей
* @param string $name_case Падеж
*
* @return stdClass|array|null Информация об аккаунте или массив с информацией об аккаунтах, если найдена
*
* @todo
* 1. Доделать
* 2. Написать обработчик ошибок возвращаемых ВКонтакте
*/
public function get(int|string|array $receiver = [], array $fields = [], ?string $name_case = null): stdClass|array|null
{
// Реиницилазиция
$this->robot->api->reinit();
if (is_int($receiver)) {
// Идентификатор
// Инициализация пользователя
$this->robot->api['user_ids'] = $receiver;
} else if (is_array($receiver)) {
// Идентификаторы
// Инициализация пользователей
$this->robot->api['user_ids'] = '';
foreach ($receiver as $key => $user_id) {
// Перебор пользователей для получения информации
// Запись пользователя
$this->robot->api['user_ids'] .= $user_id;
// Запись разделителя
if ($key === array_key_last($receiver)) break;
else $this->robot->api['user_ids'] .= ', ';
}
} else if (is_string($receiver)) {
// Домен
// Инициализация пользователя
$this->robot->api['user_ids'] = $receiver;
}
if (isset($fields)) {
// Запрошены дополнительные запрашиваемые поля
// Инициализация дополнительных запрашиваемых полей
$this->robot->api['fields'] = '';
foreach ($fields as $key => $field) {
// Перебор дополнительных запрашиваемых полей
// Запись запрашиваемого дополнительного поля
$this->robot->api['fields'] .= $field;
// Запись разделителя
if ($key === array_key_last($fields)) break;
else $this->robot->api['fields'] .= ', ';
}
}
// Инициализация падежа
if (isset($name_case)) $this->robot->api['name_case'] = $name_case;
// Запрос
$request = json_decode($this->robot->browser->request('POST', 'users.get', ['form_params' => $this->robot->api->settings])->getBody()->getContents());
// Если в ответе ошибка
if (isset($request->error)) {
throw new Exception('ВКонтакте: ' . $request->error->error_msg, $request->error->error_code);
}
return is_array($receiver) ? $request->response : (isset($request->response[0]) ? $request->response[0] : null);
}
}

View File

@@ -17,9 +17,6 @@ use mirzaev\vk\robots\robot;
* @var array $settings Настройки
* @var float $version Версия API
*
* @todo
* 1. Создать __isset(), __unset()
*
* @package mirzaev\vk\api
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
@@ -30,7 +27,7 @@ class settings implements ArrayAccess
*
* Должна иметь тип string потому, что PHP при стандартных настройках удаляет нули у float
*/
protected const VK_API_VERSION_DEFAULT = '5.130';
protected const VK_API_VERSION_DEFAULT = '5.131';
/**
* Конструктор
@@ -145,36 +142,6 @@ class settings implements ArrayAccess
return $this;
}
/**
* Инициализация получателя
*
* @see mirzaev\vk\api\methods\messages Сообщения
*/
public function destination(string|array|int $target): self
{
if (is_int($target)) {
// Идентификатор
$this->settings['peer_id'] = $target;
return $this;
} else if (is_array($target)) {
// Идентификаторы
$this->settings['user_ids'] = $target;
return $this;
} else if (is_string($target)) {
// Домен
$this->settings['domain'] = $target;
return $this;
}
throw new Exception('Не удалось определить получателя', 500);
}
/**
* Записать свойство
*
@@ -206,20 +173,44 @@ class settings implements ArrayAccess
};
}
// public function __unset(string $name): void
// {
// match ($name) {
// 'settings' => throw new Exception('Запрещено удалять настройки', 500),
// 'robot' => throw new Exception('Запрещено удалять робота', 500),
// 'data', 'attachments' => $this->offsetUnset('attachments'),
// default => $this->offsetUnset($name)
// };
// }
/**
* Проверить инициализированность свойства
*
* @param string $name Название
*
* @return bool Свойство инициализировано?
*/
public function __isset(string $name): bool
{
return match ($name) {
'settings' => isset($this->settings),
'robot' => isset($this->robot),
'data', 'attachments' => $this->offsetExists('attachments'),
default => $this->offsetExists($name)
};
}
/**
* Деинициализированность свойство
*
* @param string $name Название
*
* @return void
*/
public function __unset(string $name): void
{
match ($name) {
'settings' => throw new Exception('Запрещено деинициализировать настройки', 500),
'robot' => throw new Exception('Запрещено деинициализировать робота', 500),
'data', 'attachments' => $this->offsetUnset('attachments'),
default => $this->offsetUnset($name)
};
}
/**
* Записать по смещению
*/
public function offsetSet(mixed $offset, mixed $value): mixed
public function offsetSet(mixed $offset, mixed $value): void
{
if (isset($this->settings)) {
if (strcasecmp($offset, 'settings') === 0) {
@@ -236,21 +227,27 @@ class settings implements ArrayAccess
if (is_array($value)) {
// Жесткая запись
return $this->settings['attachments'] = $value;
$this->settings['attachments'] = $value;
return;
}
if (empty($this->settings['attachments']) || count($this->settings['attachments']) < 10) {
// Записано менее чем 10 вложений (от 0 до 9)
// Запись (конкатенация)
return $this->settings['attachments'][] = $value;
$this->settings['attachments'][] = $value;
return;
}
throw new Exception('Превышено ограничение на 10 вложений', 500);
} else {
// Запись по ключу или смещению
return $this->settings[$offset] = $value;
$this->settings[$offset] = $value;
return;
}
}
@@ -260,7 +257,7 @@ class settings implements ArrayAccess
/**
* Прочитать по смещению
*/
public function &offsetGet(mixed $offset): mixed
public function offsetGet(mixed $offset): mixed
{
if (isset($this->settings)) {
if (strcasecmp($offset, 'settings') === 0) {
@@ -284,7 +281,11 @@ class settings implements ArrayAccess
}
/**
* Проверка существования смещения
* Проверить существование смещения
*
* @param mixed $offset Сдвиг
*
* @return bool Смещение существует?
*/
public function offsetExists(mixed $offset): bool
{

View File

@@ -89,7 +89,6 @@ abstract class robot
$this->api();
}
/**
* Инициализация ключа
*
@@ -281,4 +280,14 @@ abstract class robot
{
return (string) $this->id;
}
/**
* Клонировать объект
*
* @return void
*/
public function __clone(): void {
// Инициализация робота
$this->__construct($this->id, $this->key);
}
}