njt/good-reads

用于与Goodreads API通信的PHP封装库。

1.0.0 2016-10-07 00:35 UTC

This package is not auto-updated.

Last update: 2024-09-18 20:14:41 UTC


README

用于与Goodreads API通信的PHP封装库。

Latest Stable Version License

要求

  • PHP >= 5.5.3

安装

composer require njt/good-reads

入门

在使用Goodreads API之前,您必须创建一个新的应用程序。有关详细信息,请访问注册表单

设置客户端

$gr = new GoodReads('api_key');

示例

查找书籍

您可以通过ISBN、ID或标题查找书籍

$gr->bookByISBN("ISBN");
$gr->book("id");

搜索书籍

$gr->searchBook("Search any think");
$gr->searchBookByName("Book Name");
$gr->searchBookByAuthorName('Author Name');

作者

通过Goodreads作者ID查找作者

$author = $gr->authorByID("id");

通过Goodreads作者ID查找作者书籍

$books = $gr->authorBooks("id");

通过作者名获取作者ID

$id = $gr->authorIDByName("Author Name");

通过作者名查找作者

$author = $gr->authorByName("Author Name");

作者系列

$series = $gr->seriesByAuthor("id");

评论

获取评论详细信息

$review = $gr->review('id');

通过书籍获取用户评论详细信息

$review = $gr->userReviewByBook('userID', 'bookID');

用户

通过ID获取用户

$user = $gr->userInfoByID('id');

通过用户名获取用户

$user = $gr->userInfoByUsername('username');

小组

获取小组详细信息

$group = $gr->group('id', 'sort');

参数sort是可选的,默认值为title。可以是comments_counttitleupdated_atviews之一

通过名称查找小组

$groups = $gr->findGroup('group Name');

列出给定用户所属的小组

$groups = $gr->groupsOfUser('userID', 'sort');

参数sort是可选的,默认值为members。可以是my_activitymemberslast_activitytitle之一

列出给定小组ID的小组成员

$members = $gr->groupMembers('id');

贡献

欢迎您提交补丁和新功能。

  • 为您的功能或错误修复创建一个新的分支
  • 添加测试以确保不会破坏现有代码
  • 发起一个新的pull请求
  • 查看官方API文档

许可证

MIT许可证(MIT)

Nijat Asadov,nijatasadov@gmail.com