etersoft/retypos-adapter

此包是 Etersoft Typos 系统的一部分 - 错别字修正系统。

dev-master 2018-10-29 15:54 UTC

This package is not auto-updated.

Last update: 2024-09-23 08:17:48 UTC


README

Retypos-adapter 是一组用于 PHP 服务器的接口,需要实现以使用 Etersoft 错别字修正系统。Retypos-adapter 通过 json rpc 协议工作,与错别字修正服务器交互,接收修正错别字的请求,并自动将这些更改应用到相应的服务器。

使用 Composer 安装

composer require etersoft/retypos-api

组件

Retypos-adapter API 由两个主要组件组成

TyposClient - 处理修正错别字请求并将它们自动应用到文本的组件。

TyposClientInterface - 用户需要实现其抽象方法的组件,并将其作为依赖项传递给 TyposClient。

TyposArticle - 代表文章的对象。由唯一 id 和文本组成。

使用示例

使用示例位于 example/ 文件夹中。

correctTypo.php 脚本

$interface = new MyClientInterface();

$client = new \Etersoft\Typos\TyposClient($interface);

echo $client->run();

correctTypo 脚本是系统的入口点。其任务是创建实现 MyClientInterfact 接口的对象,并使用它创建 TyposClient 的实例。客户端的输出作为响应传递给错别字修正服务器。

MyClientInterface 类

这是 TyposClientInterface 抽象类的实现。请注意两个方法的实现。

getArticleFromLink(string $link) 方法负责通过传递的文章链接或文本获取 TyposArticle 对象。在示例中,该方法简单地返回创建的 TyposArticle 对象。

protected function getArticleFromLink(string $link)
{
    return new TyposArticle(0, "");
}

在实际实现中,它应该根据链接确定文章 id,并从数据库中返回相应的文章。

saveArticle(TyposArticle $article) 方法负责将更改后的文章保存到数据库。在示例中,该方法不执行任何数据库操作,但具体实现应确保将更改后的文章文本保存到数据库中。