bananassplitter/php-haloapi

This package has for purpose to simplify the work of PHP developers who wants to use the official (beta) Halo 5 API

v1.0.3-beta 2015-12-07 08:21 UTC

README

This is a beta project

Presentation

This class has for purpose to simplify the work of PHP developers who wants to use the official Halo 5 API (beta).

Requirements

Installation

Simply download and implement the class in your project.

You can also install it through composer:

composer require bananassplitter/php-haloapi

Additional information: as the package is still in beta, be sure to set your minimum-stability to "beta"

Usage

To use the class, simply add it to your PHP file and then initialize:

$sApiKey = "xxxx"; // Use your API key - you can also use a constant.
require_once('haloapi.class.php');
$oApi = new haloapi($sApiKey, array('BananasSplitter')); // Initialize the class

...

See example.php file for concrete example.

Composer

To initialize the class with composer, proceed like following

<?php
require_once __DIR__ . '/vendor/autoload.php'; // Path to autoload file...

use PHPHaloApi\haloapi; // namespace and class name
$sApiKey = "xxxx"; // Use your API key - you can also use a constant.

$oApi = new haloapi(sApiKey , array('BananasSplitter')); // Initialize the class

...

See example.composer.php file for concrete example.

Licence

This project is under Apache 2.0 licence. See licence file.

Changelog

  • Adding vagrant to project for development purpose