Skip to content

Commit

Permalink
добавлена документация
Browse files Browse the repository at this point in the history
  • Loading branch information
FunnyRain committed Feb 7, 2021
1 parent 827a30a commit 4c35175
Show file tree
Hide file tree
Showing 4 changed files with 73 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# vkapi-user-sdk

🙍‍♂ Библиотека для управления токеном пользователя VK API

> Разрабатывается, юзабельна, если есть ошибки — сообщайте
### Методы
* [Стена (Wall)](docs/Wall.md)
* [Лайки (Likes)](docs/Likes.md)
* [Сообщения (Messages)](docs/Messages.md)

### Начало
Качаем библиотеку, сами разберётесь :)

```php
// Подключаем библиотеку
require_once "autoload.php";

// подрубаемся к библиотеке с токеном
$user = new User("токен пж");

/** ... дальше творим что хотим ... */
```

Создатель говна [во вконтактике](https://vk.com/offnikgay)

[в телеграмчике](https://t.me/vyxel)
14 changes: 14 additions & 0 deletions docs/Likes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# ❤️ Лайки (Likes)

### Поставить лайк
С помощью этой функции можно поставить лайк куда угодно.

```php
// $type — Тип контента (wall | photo и т.д)
// $owner_id — Айди владельца записи
// $item_id — Айди записи
add(string $type, int $owner_id, int $item_id)

// Пример
$user->getLikes()->add('photo', -1, 1);
```
14 changes: 14 additions & 0 deletions docs/Messages.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# ✉️ Сообщения (Messages)

### Отправить сообщение
Без комментариев.

```php
// $text — Текст сообщения
// $peer_ids — Айди беседы / пользователя (можно сделать рассылку, указав айди как String через запятую "1,2,3,4,5,6,7")
// $args — (Необязательно) Дополнительные параметры
sendMessage(string $text, $peer_ids, array $args = [])

// Пример
$user->getMessages()->sendMessage('привет лох', 1);
```
18 changes: 18 additions & 0 deletions docs/Wall.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# 🧱 Стена (Wall)

### Мониторинг стены
Короче говоря, бот смотрит стену и при любом движе сообщит вам. Удобная штука, для никому не нужных первонахов в комментариях и т.д.

```php
// owner_id — Айди группы / страницы
// $call — Callback
// $sleep — Время задержки в секундах (рекомендую 60-300 сек | потому что летит флуд контроль с токена пользователя)
listen($owner_id, $call, int $sleep)

// Пример
$user->getWall()->listen(-1, function($data) use ($user) {

// $data — Все данные поста

}, 60);
```

0 comments on commit 4c35175

Please sign in to comment.