ecn/riftconnector

Establishes connection to the RIFT chatserver API

ECNRiftConnector

, _(*1)

Installation

Install the RiftConnector via composer:, _(*2)

$ composer require ecn/riftconnector:0.1.*

Usage

The RiftConnector comes along with a RiftService class that allows easy access to shards, zones and events., _(*3)

Setup

To get a running RiftService instance, pass a connector instance to the constructor:, _(*4)

<?php

use GuzzleHttp\Client;
use Ecn\RiftConnector\Connector;
use Ecn\RiftConnector\RiftService;

$connector = new Connector(new Client(), Connector::EU_SERVER);
$service = new RiftService($connector);

Retrieving shard data

To retrieve a shard object, use the getShard() method:, _(*5)

// returns a Shard object
$shard = $service->getShard('Brutwacht');

Retrieving zones

You can query zones from the shard object:, _(*6)

// returns an array of Zone objects
$zones = $shard->getZones();

Alternatively, you can retrieve zones directly from the RiftService:, _(*7)

// returns an array of Zone objects
$zones = $service->getZones('Brutwacht');

Retrieving events

Similar to zones, events can be retrieved from the shard object or from the RiftConnector directly:, _(*8)

// returns an array of Event objects
$events = $shard->getEvents();

// returns an array of Event objects
$events = $service->getEvents('Brutwacht');

Additionally, you can check a zone directly for an event:, _(*9)

$zones = $shard->getZones();

if ($zones[0]->hasEvent()) {
    $event = $zones[0]->getEvent();
}