terminal42/webling-api

An API client for the REST API of webling.ch., _(*1)

This client is currently used for our own projects and might not support all cases. Feel free to open issues or pull requests for questions or feature requests., _(*2)

Installation

$ composer.phar require terminal42/webling-api ^2.0@dev

If you are using Symfony, we recommend using our Webling Bundle., _(*3)

Usage

$subdomain  = 'meinverein';
$apiKey     = 'foobar';
$apiVersion = '1';

$client = new Client($subdomain, $apiKey, $apiVersion);

// Example call for member list:
$client->get('member');

The EntityManager

If you're looking for a more convenient way to work with the API instead of calling it directly, you can work with the EntityManager., _(*4)

The main issue with the webling API is the fact that requesting resource lists (e.g. /member) will only return an array of object ID's instead of additional data like the member last name or first name., _(*5)

The EntityList will take care of this and lazy load the additional details whenever you need them. That way you can easily iterate over a list of members:, _(*6)

$em = EntityManager::createForAccount($subdomain, $apiKey);

$entityList = $em->findAll('member');

foreach ($entityList as $member) {

    echo $member->getId();
    echo $member->getProperty('Name');
    var_dump($member->getProperties());
    // etc.
}

The QueryBuilder

The QueryBuilder components allows to find entities using complex search queries. It is highly recommended to use an IDE with code autocompletion for easy usage., _(*7)

Example 1: find member by name

$qb = new QueryBuilder();
$query = $qb->where('Firstname')->isEqualTo('Max')->andWhere('Lastname')->isEqualTo('Muster')->build();

Result: Firstname = "Max" AND Lastname = "Muster", _(*8)

Example 2: find member by complex conditions

$qb = new QueryBuilder();

$query = $qb
    ->group(
        $qb->where('Firstname')->isEqualTo('Max')->andWhere('Lastname')->isEqualTo('Muster')
    )
    ->orGroup(
        $qb->where('Firstname')->isEqualTo('Muster')->andWhere('Lastname')->isEqualTo('Max')
    )
    ->build()
;

Result: '(Firstname = "Max" AND Lastname = "Muster") OR (Lastname = "Max" AND "Firstname" = "Muster")', _(*9)

24/08 2017

dev-develop

API client for webling.ch

Sources Download

LGPL-3.0+

library webling-api

API client for webling.ch