krylov123/textru-api

Text.ru API 的 PHP 连接器

v1.0.2 2020-09-11 10:31 UTC

This package is auto-updated.

Last update: 2024-09-11 19:38:39 UTC


README

text.ru API 的 PHP 连接器。易于集成到主要的 PHP 框架(已在 Laravel 上测试)。

安装

composer install textru-api

API 描述

使用 text.ru 的 POST 版本 API,有关 API 的更多信息,请参阅链接:[https://text.ru/api-check/manual](https://text.ru/api-check/manual)

示例

实现了两种使用组件的方式,一种是创建类实例,另一种是不创建实例(通过静态方法)。

选项 1. 创建类实例

如果只有一个 text.ru 账户,这种方法很方便。首先创建一个类实例,传递给它您的 userkey

$userkey = 'Ваш text.ru userkey';
$text = 'Проверяемый текст, не менее 100 символов';

$app = new \TextRuApi\TextRuApi($userkey);

//Добавляете текст на проверку и сохраняете text_uid для последующего получения результатов
$options = ["exceptdomain"=>"mydomain.ru"]; //Необязательный параметр. Массив дополнительных параметров (см. описание API)
$result = TextRuApi->add($text, $options);
$uid = $result["text_uid"];

//Требуется выждать паузу чтобы сервис успел обработать текст.
//Рекомендуется больше минуты.
sleep(15);

//Получаете результат проверки
$jsonvisible = 'detail'; //Необязательный параметр. Укажите "detail" чтобы получить расширенные данные по тексту
$result = TextRuApi->get($uid, $jsonvisible);

选项 2. 不创建类实例

可以直接使用方法作为静态方法,每次调用时传递您的 userkey 这在您使用多个 text.ru 账户时很方便。

$userkey = 'Ваш text.ru userkey';
$text = 'Проверяемый текст, не менее 100 символов';

//Добавляете текст на проверку и сохраняете text_uid для последующего получения результатов
$options = ["exceptdomain"=>"mydomain.ru"]; //Необязательный параметр. Массив дополнительных параметров (см. описание API)
$result = TextRuApi::add($userkey, $text, $options);
$uid = $result["text_uid"];

//Требуется выждать паузу чтобы сервис успел обработать текст.
//Рекомендуется больше минуты.
sleep(15);

//Получаете результат проверки
$jsonvisible = 'detail'; //Необязательный параметр. Укажите "detail" чтобы получить расширенные данные по тексту
$result = TextRuApi::get($userkey, $uid, $jsonvisible);

获取剩余字符数

获取所有包的总剩余字符数

$userkey = 'Ваш text.ru userkey';

$result = TextRuApi::account($userkey);
//или
$app = new \TextRuApi\TextRuApi($userkey);
$result = $app->account();

var_dump($result['size']);

PHPUnit 测试

从组件根目录运行

./vendor/phpunit/phpunit/phpunit --no-coverage