README

The Holiday Oracle PHP库提供了从您的PHP应用程序方便访问由Off Chain Data提供的全球假日API的方法。

安装

使用composer安装

composer require offchaindata/holiday-oracle-php

调用API

注意，所有方法都接受一个可选的数组作为最后一个参数，该参数可以用来向API传递可选参数。例如：

public function holidays($country, $year, array $options = [])

首先创建Holiday Oracle客户端对象的实例

<?php

require_once __DIR__ . '/vendor/autoload.php'; // Autoload files using Composer autoload
use OffChainData\HolidayOracle\Client;
$client = new Client('INSERT API TOKEN');

要获取支持的位置（国家和子区域）列表，请调用locations()方法。

try {
    $response = $client->locations();
    ...
} catch (\Exception $e) {
    echo $e->getMessage();
}

可以使用日期端点来确定日期是工作日还是假日。它还可以用来计算下一个N个工作日。

try {
    $response = $client->date('2020-01-01', 'AU', ['subdivision' => 'NSW']);
    ...
} catch (\Exception $e) {
    echo $e->getMessage();
}

要获取某个位置的假日列表，请通过holidays()方法实现。

try {
    $response = $client->holidays('AU', '2020');
    ...
} catch (\Exception $e) {
    echo $e->getMessage();
}

最后，要计算两个日期之间的工作/工作日，请调用businessDays()方法。

try {
    $response = $client->businessDays('2020-01-01', '2020-02-01', 'AU');
    ...
} catch (\Exception $e) {
    echo $e->getMessage();
}

错误

客户端库在验证错误和API返回错误时将抛出异常。具体的API错误代码可以按照以下方式返回

try {
    $response = $client->businessDays('2020-01-01', '2020-02-01', 'AU');
    ...
} catch (\Exception $e) {
    var_dump($client->getLastResponseStatus());
}

支持的地点

以下是API支持的地点列表。如果一个国家没有子区域，则返回整个国家的假日。如果有定义子区域，可以在国家和子区域级别查询假日。

您还可以在此处查询API支持的地点列表。

offchaindata / holiday-oracle-php

维护者

详细信息

README

安装

调用API

错误

支持的地点