Skip to content

Commit 4c35175

Browse files
committed
добавлена документация
1 parent 827a30a commit 4c35175

File tree

4 files changed

+73
-0
lines changed

4 files changed

+73
-0
lines changed

README.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# vkapi-user-sdk
2+
3+
🙍‍♂ Библиотека для управления токеном пользователя VK API
4+
5+
> Разрабатывается, юзабельна, если есть ошибки — сообщайте
6+
7+
### Методы
8+
* [Стена (Wall)](docs/Wall.md)
9+
* [Лайки (Likes)](docs/Likes.md)
10+
* [Сообщения (Messages)](docs/Messages.md)
11+
12+
### Начало
13+
Качаем библиотеку, сами разберётесь :)
14+
15+
```php
16+
// Подключаем библиотеку
17+
require_once "autoload.php";
18+
19+
// подрубаемся к библиотеке с токеном
20+
$user = new User("токен пж");
21+
22+
/** ... дальше творим что хотим ... */
23+
```
24+
25+
Создатель говна [во вконтактике](https://vk.com/offnikgay)
26+
27+
[в телеграмчике](https://t.me/vyxel)

docs/Likes.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# ❤️ Лайки (Likes)
2+
3+
### Поставить лайк
4+
С помощью этой функции можно поставить лайк куда угодно.
5+
6+
```php
7+
// $type — Тип контента (wall | photo и т.д)
8+
// $owner_id — Айди владельца записи
9+
// $item_id — Айди записи
10+
add(string $type, int $owner_id, int $item_id)
11+
12+
// Пример
13+
$user->getLikes()->add('photo', -1, 1);
14+
```

docs/Messages.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# ✉️ Сообщения (Messages)
2+
3+
### Отправить сообщение
4+
Без комментариев.
5+
6+
```php
7+
// $text — Текст сообщения
8+
// $peer_ids — Айди беседы / пользователя (можно сделать рассылку, указав айди как String через запятую "1,2,3,4,5,6,7")
9+
// $args — (Необязательно) Дополнительные параметры
10+
sendMessage(string $text, $peer_ids, array $args = [])
11+
12+
// Пример
13+
$user->getMessages()->sendMessage('привет лох', 1);
14+
```

docs/Wall.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# 🧱 Стена (Wall)
2+
3+
### Мониторинг стены
4+
Короче говоря, бот смотрит стену и при любом движе сообщит вам. Удобная штука, для никому не нужных первонахов в комментариях и т.д.
5+
6+
```php
7+
// owner_id — Айди группы / страницы
8+
// $call — Callback
9+
// $sleep — Время задержки в секундах (рекомендую 60-300 сек | потому что летит флуд контроль с токена пользователя)
10+
listen($owner_id, $call, int $sleep)
11+
12+
// Пример
13+
$user->getWall()->listen(-1, function($data) use ($user) {
14+
15+
// $data — Все данные поста
16+
17+
}, 60);
18+
```

0 commit comments

Comments
 (0)