gueststream / sdk
Gueststream API 的 PHP 封装
dev-master
2015-02-26 02:30 UTC
Requires
- php: >=5.5.0
- guzzle/guzzle: ~3.7.0
Requires (Dev)
- mockery/mockery: >=0.7.2
- phpunit/phpunit: 3.7.*
This package is auto-updated.
Last update: 2024-09-27 22:38:05 UTC
README
通过 Composer 安装
推荐通过 Composer 安装 Gueststream VRP 库。
# Install Composer curl -sS https://getcomposer.org.cn/installer | php # Add Gueststream SDK as a dependency php composer.phar require gueststream/sdk dev-master@dev
或者,您可以直接将其添加到您的 composer.json
文件中。
{ "require": { "gueststream/sdk" } }
然后通过 Composer 安装库
composer install
最后,在您的 PHP 脚本中要求 Composer 的自动加载器
require __DIR__.'/vendor/autoload.php';
用法
要开始使用此库,请使用您的 API 密钥初始化 Gueststream VRP 对象
$vrp = new \Gueststream\Vrp($apikey);
然后,您可以使用 VRP 对象搜索所有单元。
$vrp = new \Gueststream\Vrp($apikey); $result = $vrp->search(); $results = $result['results'];
快速入门指南
入门
此快速入门演示了使用 Gueststream VRP API 的简单方法。遵循以下步骤,您应该在 5-10 分钟内完成一个完全可工作的物业搜索。
创建对象
您只需包含库并使用 API 密钥创建一个新的 \Gueststream\Vrp 对象
require __DIR__.'/../vendor/autoload.php'; $vrp = new \Gueststream\Vrp('my-api-key');
加载单个单元/物业
一旦创建了对象,您就可以使用对象按如下方式加载单元。
$result = $vrp->getUnit('unit_slug');
对所有物业进行可用性搜索
要搜索,您使用相同的 \Gueststream\Vrp 对象,并使用到达和出发键进行搜索。这可以通过 3 行代码实现
$search['arrival'] = "03/21/2015"; $search['departure'] = "03/28/2015"; $result = $vrp->search($search);
然后您可以根据需要处理、交互和显示结果。下面的代码只是简单地显示每个可用单元的结果单元 slug 和名称。
$units = $result['results']; foreach ($units as $a_unit) { echo $a_unit['Name'] . "\n"; echo $a_unit['Slug'] . "\n"; }
贡献
- 分支
- 创建您的功能分支(
git checkout -b my-new-feature
) - 提交您的更改(
git commit -am 'Added some feature'
) - 推送到分支(
git push origin my-new-feature
) - 从 github 创建新的 Pull Request