README

PHP 包装器 / jsonbox 客户端 SDK

安装

$ composer require anper/jsonbox

使用

use Anper\Jsonbox\Jsonbox;

$jsonbox = Jsonbox::factory('box-id');

创建

// Create a record
$response = $jsonbox->create(['name' => 'Arya Stark']);

// Create multiple records
$response = $jsonbox->create([
    ['name' => 'Daenerys Targaryen'],
    ['name' => 'Arya Stark'],
]);

// Create a collection
$response = $jsonbox->colletion('users')
    ->create(/* like one record or multiple records */);   

读取

// Read a record
$response = $jsonbox->record('5d776a25fd6d3d6cb1d45c51')->read();

// Read a collection
$response = $jsonbox->collection('users')->read();

// Read all
$response = $jsonbox->read();

过滤

$filter = new \Anper\Jsonbox\Filter();
$filter->equalTo('name', 'Arya Stark');

// Filter all
$response = $jsonbox->read($filter);

// Filter collection
$response = $jsonbox->collection('users')->read($filter);

更新

// Update a record
$response = $jsonbox->record('5d776a25fd6d3d6cb1d45c51')
    ->update(['name' => 'Arya Stark']);

// Update multiple records (async request for every record)
$response = $jsonbox->update([
    '5d776b75fd6d3d6cb1d45c52' => ['name' => 'Daenerys Targaryen'],
    '5d776b75fd6d3d6cb1d45c53' => ['name' => 'Arya Stark'],
]);

删除

// Delete a record
$response = $jsonbox->record('5d776a25fd6d3d6cb1d45c51')->delete();

// Delete multiple records (async request for every record)
$response = $jsonbox->delete([
    '5d776b75fd6d3d6cb1d45c52',
    '5d776b75fd6d3d6cb1d45c53',
]);

// Delete by filter
$response = $jsonbox->delete($filter);

受保护箱

// An API-KEY should be a valid GUID/UUID
$protectedJsonbox = $jsonbox->withApiKey('API_KEY');

测试

$ composer test

贡献

请参阅 CONTRIBUTING 获取详细信息。

许可

MIT 许可证 (MIT)。请参阅 许可文件 获取更多信息。