Skip to content

Commit 41bf3a6

Browse files
committed
Update README text
1 parent d26c2c6 commit 41bf3a6

File tree

1 file changed

+39
-10
lines changed

1 file changed

+39
-10
lines changed

README.md

+39-10
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,63 @@
22
PHP коннектор для API сайта text.ru.
33
Легко интегрируется в основные php фреймворки (протестирован на Laravel).
44

5-
##Установка
5+
## Установка
66
composer install textru-api
77

8-
##Описание API
8+
## Описание API
99
Используется POST версия API от text.ru, более подробную информацию об API можно найти по ссылке:
1010
https://text.ru/api-check/manual
1111

12-
##Примеры
13-
Все методы можно использовать как статические (без создания класса).
12+
## Примеры
13+
Реализовано два варианта использования компонента, с созданием экземпляра класса и без него (через статические методы).
14+
15+
### Вариант 1. С созданием экземпляра класса
16+
Способ удобен если у вас один аккаунт на text.ru
17+
Первым делом создаете экземпляр класса, передав в него свой [userkey](https://text.ru/api-check)
1418

15-
####Добавление текста на проверку
1619
```php
17-
//Добавление текста на проверку
1820
$userkey = 'Ваш text.ru userkey';
1921
$text = 'Проверяемый текст, не менее 100 символов';
22+
23+
$app = new \TextRuApi\TextRuApi($userkey);
24+
25+
//Добавляете текст на проверку и сохраняете text_uid для последующего получения результатов
2026
$options = ["exceptdomain"=>"mydomain.ru"]; //Необязательный параметр. Массив дополнительных параметров (см. описание API)
27+
$result = TextRuApi->add($text, $options);
28+
$uid = $result["text_uid"];
2129

22-
$result = TextRuApi::add($userkey, $text);
23-
$uid = $result["text_uid"]; //идентификатор текста, сохраните его для следующего шага
30+
//Требуется выждать паузу чтобы сервис успел обработать текст.
31+
//Рекомендуется больше минуты.
32+
sleep(15);
33+
34+
//Получаете результат проверки
35+
$jsonvisible = 'detail'; //Необязательный параметр. Укажите "detail" чтобы получить расширенные данные по тексту
36+
$result = TextRuApi->get($uid, $jsonvisible);
2437
```
2538

26-
####Получение результатов проверки
39+
### Вариант 2. Без создания экземпляра класса
40+
Можно просто использовать методы как статически, каждый раз передавая в них ваш [userkey](https://text.ru/api-check)
41+
Это удобно когда вы используете много аккаунтов text.ru
42+
2743
```php
44+
$userkey = 'Ваш text.ru userkey';
45+
$text = 'Проверяемый текст, не менее 100 символов';
46+
47+
//Добавляете текст на проверку и сохраняете text_uid для последующего получения результатов
48+
$options = ["exceptdomain"=>"mydomain.ru"]; //Необязательный параметр. Массив дополнительных параметров (см. описание API)
49+
$result = TextRuApi::add($userkey, $text, $options);
50+
$uid = $result["text_uid"];
51+
52+
//Требуется выждать паузу чтобы сервис успел обработать текст.
53+
//Рекомендуется больше минуты.
54+
sleep(15);
55+
56+
//Получаете результат проверки
2857
$jsonvisible = 'detail'; //Необязательный параметр. Укажите "detail" чтобы получить расширенные данные по тексту
2958
$result = TextRuApi::get($userkey, $uid, $jsonvisible);
3059
```
3160

32-
##PHPUnit тесты
61+
## PHPUnit тесты
3362
Запуск из корня компонента
3463
```bash
3564
phpunit ./tests/AddMethodTest.php --no-coverage

0 commit comments

Comments
 (0)