cbix/cbix-php

加拿大比特币指数API的PHP库

dev-master 2015-05-06 04:06 UTC

This package is not auto-updated.

Last update: 2024-09-14 15:47:39 UTC


README

Build Status Code Climate Test Coverage

此库提供了一个简单的PHP接口,用于访问加拿大比特币指数API

通过Composer安装

推荐通过 Composer 安装此库。

# Install Composer
curl -sS https://getcomposer.org/installer | php

# Add Chain-PHP as a dependency
php composer.phar require cbix/cbix-php:dev-master

安装后,您需要引入Composer的自动加载器

require 'vendor/autoload.php';

设置

只需在Cbix类上调用make方法。

$cbix = Cbix::make();

方法

支持所有CBIX API方法,并将在完全支持后添加更多。

$index = $cbix->index();
$history = $cbix->history(['limit=100']);
$convert = $cbix->convert(500, 'CAD', 'BTC');
$news = $cbix->news();
$summary = $cbix->summary();
$orderbook = $cbix->orderbook(['limit=25']);
$volatility = $cbix->volatility(['limit=10']);

异常

如果在API请求过程中出现任何问题,将抛出一个CbixException异常,可以根据您的应用程序需求进行捕获和处理。

try {
    $index = $cbix->index();
    echo $index->index->value;
} catch (CbixException $e) {
    //There was an error more information in $e->getMessage();
    var_dump($e->getMessage());
}

单元测试

此库使用PHPUnit进行单元测试。为了运行单元测试,您首先需要使用Composer安装项目的依赖项: php composer.phar install --dev。然后,您可以使用 vendor/bin/phpunit 运行测试。该库包含来自CBIX API的一组模拟响应,用于运行单元测试。

贡献

欢迎补丁、错误修复、功能请求和pull请求。