hirvi / ticketco-php
为 TicketCo.no 提供简单的 API 包装器
v1.0.23
2018-04-30 12:52 UTC
Requires
- php: >=5.6.0
- guzzlehttp/guzzle: ~5.0|~6.0
- illuminate/support: ~5.0
Requires (Dev)
- phpspec/phpspec: ~3.3
This package is not auto-updated.
Last update: 2024-09-15 01:58:57 UTC
README
安装
将以下内容添加到您的 composer.json 中
{ "require": { "hirvi/ticketco-php": "~1.0" } }
Laravel 用户
我们添加了一些类,以便 Laravel 5 用户可以轻松使用该库。
服务提供者
您可以在 app.php
配置文件中注册我们的 服务提供者。
// config/app.php 'providers' => [ ... TicketCo\Laravel\TicketCoServiceProvider::class ]
外观
如果您更喜欢 外观,请确保也添加此内容
// config/app.php 'aliases' => [ ... 'TicketCo' => TicketCo\Laravel\TicketCoFacade::class ]
配置
您只需填写一个配置选项。通过运行以下命令发布配置
php artisan vendor:publish
现在,配置文件将位于 config/ticketco.php
下
<?php return [ /* |-------------------------------------------------------------------------- | TicketCo API key |-------------------------------------------------------------------------- | | To obtain an API key, contact TicketCo or fill out this form: | https://app.pipefy.com/public_form/155824 | */ 'apikey' => '' ];
用法
初始化
除非您使用 Laravel Facade,否则您需要通过传递 API 密钥来初始化客户端。
<?php require_once __DIR__ . '/vendor/autoload.php'; $ticketco = new TicketCo\Client('api-key');
获取所有事件
<?php // Fetch all events $events = $ticketco->events()->all(); // ... or if you are using the Laravel Facade $events = TicketCo::events()->all(); // Using the Collection object, you can // loop through all events using `each(callback)` $events->each(function($event) { echo $event->title; }); // ... or you can use foreach like with any other object/array foreach($events as $event) { echo $event->title; } // ... or if you don't like the Collection object // you can transform it into an array $events = $events->toArray();
获取单个活动
// Fetch single event $event = $ticketco->events()->get('<id>'); echo $event->title;
获取活动状态
检查活动是否可用或已结束。
$status = $ticketco->events()->status('<id>'); // Will return "available" or "ended".
集合对象
查询将返回一个 Illuminate\Support\Collection 对象的实例,它非常容易处理。但是,如果您不想使用集合对象,可以使用 $result->toArray()
将其转换为数组。
更多文档
TicketCo 的 API 文档位于此处: http://apidoc.ticketco.no/api/v1/public。