webuni/srazy-api-client

The missing API for http://srazy.info

dev-master / 1.0.x-dev 2016-04-25 07:08 UTC

This package is auto-updated.

Last update: 2020-10-04 19:13:37 UTC


README

Latest Stable Version Build Status Scrutinizer Code Quality SensioLabsInsight

Chybějící API pro http://srazy.info

Instalace

Knihovnu nainstalujeme přes Composer:

composer require webuni/srazy-api-client

Použití

Vytvoříme klienta

use Webuni\Srazy\Client;

$client = new Client();

Klient umí pracovat s uživateli, srazy a jednotlivými událostmi

$userApi = $client->user();
$seriesApi = $client->series();
$eventApi = $client->event();

Srazy vyhledáme pomocí

$series = $seriesApi->find('symfony')->first();

K jednotlivým vlastnostem srazu přistupujeme pomocí metod

$series->getName();
$series->getDescription();
$series->getFollowers();
$series->getEvents();

U každé události můžeme přistupovat

foreach ($series->getEvents() as $event) {
    $event->getName();
    $event->getDescription();
    $event->getStart();
    $event->getEnd();
    $event->gteLocation();
    $event->getSessions();
    $event->getComments();
}

Plán vývoje

  • 1.0 - (duben 2016) kompletní API pro čtení veřejných informací
  • 1.1 - podpora pro přihlášené uživatele a čtení informací viditelných pro přihlášené uživatele
  • 2.0 - API pro úpravy