nolikein/api-derpibooru-facade

为Laravel编写的库,用于与derpibooru的API通信和建模

1.0.0 2021-08-21 18:25 UTC

This package is auto-updated.

Last update: 2024-09-22 01:11:17 UTC


README

这是一个为Laravel编写的库,用于通过模型与derpibooru的API进行通信和建模。Laravel是一个PHP框架。

如何安装

您可能希望通过Composer安装它,请输入以下命令行

composer require nolikein/api-derpibooru-facade ^1.0.0

使用方法

首先,创建一个允许您进行请求的类。请求者

use Nolikein\ApiDerpibooruFacade\Requester;

$requester = new Requester();

然后,请求的示例

use Nolikein\ApiDerpibooruFacade\Models\Image;

/** @var Image $image A model who represent an image */
$image = $requester->getImageById(1);
dd($image->name);

但该类有许多方法

# Basic requests by id
$requester->getCommentById(idComment: $id);
$requester->getImageById(idImage: $id);
$requester->getTagById(tagId: $id);
$requester->getPostById(postId: $id);
$requester->getUserById(userId: $id);
$requester->getFilterById(filterId: $filter_id, authToken: $key = null);

# Basic requests by query
$requester->getCommentsByQuery(query: $q, authToken: $key = null, page: $page = null);
$requester->getGalleriesByQuery(query: $q, authToken: $key = null, page: $page = null);
$requester->getPostsByQuery(query: $q, authToken: $key = null, page: $page = null);
$requester->getImagesByQuery(query: $q, authToken: $key = null, page: $page = null, perPage: $per_page = null, filterId: $filter_id = null, sortDirection: $sd = null, sortField: $sf = null);
$requester->getTagsByQuery(query: $q, page: $page = null);

# Forum requests
$requester->getForums();
$requester->getForum(forumShortName: $short_name);
$requester->getTopics(forumShortName: $short_name, page: $page = null, perPage: $per_page = null);
$requester->getTopic(forumShortName: $short_name, topicSlug: $slug);
$requester->getPostsFromTopic(forumShortName: $short_name, topicSlug: $slug, page: $page = null, perPage: $per_page = null);
$requester->getPostFromTopic(forumShortName: $short_name, topicSlug: $topic_slug, topicId: $post_id);

# Miscellaneous requests
$requester->getFeaturedImage();
$requester->getFilterList(page: $page = null);
$requester->getUserFilters(authToken: $key, page: $page = null);
$requester->getOembedByUrl(url: $url);
$requester->doReverseImageSearchByUrl(url: $url, authToken: $key = null, distance: $distance = null);

发布配置文件和测试

根据您的需求运行以下命令

artisan vendor:publish --tag=api-derpibooru-facade-config
artisan vendor:publish --tag=api-derpibooru-facade-tests

许可证

此库遵循MIT许可证