README

PHP LearnyBox API 客户端提供了从用 PHP 编写的应用程序方便访问 LearnyBox API 的途径。它包括一组预定义的类，这些类可以从 API 响应中动态初始化，使其与 LearnyBox API 的多个版本兼容。

要求

• PHP 7.1.0 及更高版本
• Guzzle 库
• (可选) PHPUnit 运行测试

安装

您可以使用 Composer 或简单地进行 手动安装

Composer

首选方法是使用 composer。如果您还没有安装 composer，请按照 安装说明 进行。

一旦 composer 安装完成，请在您的项目根目录中执行以下命令以安装此库

composer require learnybox/learnybox-client-php

最后，请确保包含自动加载器

require_once('vendor/autoload.php');

手动安装

如果您讨厌使用 composer，您可以下载整个包。在 版本 页面上列出了所有稳定版本。下载任何以 learnybox-client-php-[RELEASE_NAME].zip 命名的文件，它包含此库及其依赖项。

解压缩您下载的 zip 文件，并在您的项目中包含自动加载器

require_once('/path/to/learnybox-client-php/vendor/autoload.php');

基本用法

// load Composer
require('vendor/autoload.php');

use LearnyBox\Client;

$client = Client::create([
    'api_key' => 'abc123',
    'subdomain' => 'my-subdomain'
]);

$resultContacts = $client->get('mail/contacts/');

$resultNewContact = $client->post('mail/contacts/', [
    'nom' => 'Doe',
    'prenom' => 'John',
    'email' => 'john.doe@mail.com'
]);
$contactId = $resultNewContact->data->id_contact;

$resultEditContact = $client->patch('mail/contacts/', [
    'id_contact' => $contactId,
    'new_email' => 'john.doe.bis@mail.com',
]);
        
$resultContact = $client->get('mail/contacts/' . $contactId . '/');

$resultDelete = $client->delete('mail/contacts/' . $contactId . '/');

$client 对象为您提供了对整个 LearnyBox API 的访问。

缓存

建议使用其他缓存库来提高性能。这可以通过向客户端传递一个 PSR-6 兼容的库来完成

use League\Flysystem\Adapter\Local;
use League\Flysystem\Filesystem;
use Cache\Adapter\Filesystem\FilesystemCachePool;

$filesystemAdapter = new Local(__DIR__.'/');
$filesystem        = new Filesystem($filesystemAdapter);

$cache = new FilesystemCachePool($filesystem);
$client->setCache($cache);

在此示例中，我们使用 PHP Cache。使用 composer 将其添加到您的项目中

composer require cache/filesystem-adapter

开发

安装依赖项

composer install

复制并配置 phpunit.xml 文件

cp ./phpunit.xml.dist ./phpunit.xml

运行测试套件

./vendor/bin/phpunit

或者运行单个测试文件

./vendor/bin/phpunit tests/ClientTest.php

贡献

请随意提出任何评论、报告问题或发起拉取请求。

许可证

PHP LearnyBox API 客户端是开源软件，受 MIT 许可证 许可。