towa/eventserver-sdk

PHP SDK for the eventserver-api

v1.2.1 2020-04-06 21:22 UTC

README

Version Software License

Developer SDK for interacting with the Eventserver API

Usage

Events

Basic Request with no options

$eventserver = new Eventserver($token);

$response = $eventserver->get();

$events = $response['data']; // events
$links = $response['links']; // pagination links
$meta = $response['meta']; // meta information

Basic Request with with options

The available options will be documented shortly.

$eventserver = new Eventserver($token);

$response = $eventserver
    ->withOptions([
        'include' => 'location,categories',
        'page' => [
            'size' => 10,
            'number' => 1,
        ],
    ])
    ->get();

$events = $response['data']; // events
$links = $response['links']; // pagination links
$meta = $response['meta']; // meta information

Request with non default endpoint

$eventserver = new Eventserver($token);

$response = $eventserver
    ->withEndpoint('categories')
    ->get();

$categories = $response['data'];

Changelog

Please see the Changelog for more information.

Testing

▲ composer test

Requirements

  • .env-file in the root with a valid EVENTSERVER_TOKEN token

Credits

About Towa

Towa is a digital agency based in Bregenz (Austria), Vienna (Austria) & St. Gallen (Switzerland).

License

The MIT License (MIT). Please read the LICENSE.md for more information.