latheesan-k/laravel-xero

Xero Service Provider for Laravel 4

Xero Service Provider for Laravel 4

Originally forked from https://github.com/VentureCraft/xero-laravel and updated to support newer API features (e.g. ContactGroups and paging results etc...)., _(*1)

A simple Laravel 4 service provider for including the PHP Xero API., _(*2)

Installation

The Xero Service Provider can be installed via Composer by requiring the latheesan-k/laravel-xero package and setting the minimum-stability to dev in your project's composer.json., _(*3)

{
    "require": {
        "laravel/framework": "4.0.*",
        "latheesan-k/laravel-xero": "dev-master"
    },
    "minimum-stability": "dev"
}

Usage

To use the Xero Service Provider, you must register the provider when bootstrapping your Laravel application., _(*4)

Use Laravel Configuration

Create a new app/config/xero.php configuration file with the following options:, _(*5)

return array(
    'key'           => '<your-xero-key>',
    'secret'        => '<your-xero-secret>',
    'publicPath'    => app_path() .'/config/xero/publickey.cer',
    'privatePath'   => app_path() .'/config/xero/privatekey.pem'
);

Find the providers key in app/config/app.php and register the Xero Service Provider., _(*6)

    'providers' => array(
        // ...
        'Latheesan\LaravelXero\LaravelXeroServiceProvider',
    )

Find the aliases key in app/config/app.php and add in our LaravelXero alias., _(*7)

    'aliases' => array(
        // ...
        'LaravelXero'     => 'Latheesan\LaravelXero\Facades\LaravelXero',
    )

Setting up the application

Create public and private keys, and save them in /app/config/xero/ as publickey.cer and privatekey.pem., _(*8)

For more info on setting up your keys, check out the Xero documentation, _(*9)

Example Usage

Create a Contact in Xero, _(*10)

$contact = array(
    array(
        "Name"        => 'Company Name Ltd',
        "FirstName"   => 'John',
        "LastName"    => 'Doe',
    )
);

$xero_contact = LaravelXero::Contacts($contact);

GET Contacts with WHERE clause & Paging, _(*11)

$where = "ContactNumber!=null&IsCustomer=true";
$page  = 1;

print_r(LaravelXero::Contacts(false, false, $where, false, $page));

Reference

• PHP Xero API
• Laravel website