cbzink/launchlibrary

Launch Library 2 的非官方 SDK。

v1.0.1 2022-08-06 17:44 UTC

This package is auto-updated.

Last update: 2024-09-06 22:41:40 UTC


README

Build Status Latest Stable Version Total Downloads License

一个用于与 Launch Library 2 API 交互的简单 SDK。

目录

查看目录。

需求

  • PHP >= 7.4
  • LL2 API 令牌 (可选)

安装

通过 Composer 安装此库。

composer require cbzink/launchlibrary

使用

设置

实例化 LL2 类的一个实例

use cbzink\LaunchLibrary\LL2;

$client = new LL2($apiToken, $apiEndpoint);

分页限制

您可以使用 setPaginationLimit 方法更改分页限制(默认 10)。

$client->setPaginationLimit(30);

$client->getPaginationLimit() // (int) 30

资源

目前可用的资源包括机构、宇航员、对接事件、事件、任务、发射器、发射、位置、发射台、空间站和航天器。

搜索资源

您可以使用 LL2 API 文档 中指定的参数搜索资源。

$results = $client->agencies()->search([
    'country_code' => 'US',
]);

分页

搜索通常是分页的。资源数组位于 results 属性下,且提供 next()previous() 方法来遍历分页。

$agencies = $client->agencies()->search();

// Array of Agency resources.
$resources = $agencies->results;

// Fetch the next page of results
$agencies = $agencies->next();

检索资源

您可以通过其 ID 检索详细资源。

$results = $client->agencies()->fetch(123);

特殊情况

活动和发射

活动和发射有额外的 Previous 和 Upcoming 端点,您可以使用 SDK 访问它们。两者都提供 search()fetch()

// Previous
$results = $client->events()->previous()->search();

// Upcoming
$results = $client->launches()->upcoming()->search();

航天器

航天器有额外的 Flights 端点,您可以使用 SDK 访问。两者都提供 search()fetch()

$results = $client->spacecraft()->flights()->search();

致谢

此 SDK 的设计灵感来自 laravel/forge-sdkKnpLabs/php-github-api

许可证

PHP 的 Launch Library 2 SDK 是开源软件,许可协议为 MIT 许可证