eekes/vbl-api

PHP wrapper for the VBL API that turns all data into nice objects.

Maintainers

Details

github.com/eekes/vbl-api

Homepage

Source

Issues

Installs: 153

Dependents: 0

Suggesters: 0

Security: 0

Stars: 3

Watchers: 2

Forks: 0

Open Issues: 0

v1.0.5 2022-02-06 11:18 UTC

Requires

Requires (Dev)

MIT 9165495a238e980dede9550d45980b11dc10d0b8

This package is auto-updated.

Last update: 2025-03-06 18:14:24 UTC

README

Testing Scrutinizer Code Quality

PHP wrapper for the VBL (Basketbal Vlaanderen) API to get all data as nice objects, making it much easier to use on you club's website.

Usage

Install using composer:

composer require eekes/vbl-api

Then use any of these static methods:

use Eekes\VblApi\Api\GamesApi;
use Eekes\VblApi\Api\MembersApi;
use Eekes\VblApi\Api\ClubApi;
use Eekes\VblApi\Api\TeamApi;

$gamesByTeamId = GamesApi::byTeamId("xxx");
$gamesByClubId = GamesApi::byClubId("xxx");

$members = MembersApi::byClubId("xxx");

$club = ClubApi::byId("xxx");

$team = TeamApi::byId("xxx");

Every method uses return types (combined with type-hinted annotations if needed) so each response should be self-explanatory and add auto-completion in your IDE.

Contributing and testing

If you see improvements or bugs, feel free to contribute!

Provisioning for local development is provided. You can simply run vagrant up and run tests within the /vagrant directory by running: ./vendor/bin/phpunit.

You'll need to provide these env values in order for the tests to work:

CLUB_ID=club_id
TEAM_ID="team_id"