fourlabs/xero-bundle

Symfony bundle wrapping the XeroPHP library

1.2.0 2018-07-10 11:14 UTC

Requires

• php: >=5.5.9
• calcinai/xero-php: ^1.8
• symfony/config: ^2.7|^3.0
• symfony/debug: ^2.7|^3.0
• symfony/dependency-injection: ^2.7|^3.0
• symfony/framework-bundle: ^2.7|^3.0

MIT

• Four Labs

• xero
• xero-php

README

This is a Symfony bundle wrapping the XeroPHP library. From the library's github page:

A client implementation of the Xero API, with a cleaner OAuth interface and ORM-like abstraction.

I hate reinventing the wheel, but this was written out of desperation. I wasn't comfortable putting the implementation that's recommended by Xero in to production, even after persisting with extending it.

This is loosely based on the functional flow of XeroAPI/XeroOAuth-PHP, but is split logically into more of an OO design.

Download the bundle using composer

composer require fourlabs/xero-bundle

Enable the bundle

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new FL\XeroBundle\FLXeroBundle(),
        // ...
    );
}

Configure the bundle

For a full configuration reference use:

php bin/console config:dump-reference FLXeroBundle

Example of a private app configuration:

fl_xero:
  type: private
  oauth:
    callback: "https://mydomain.com/xero-callback"
    consumer_key: "%xero_consumer_key%"
    consumer_secret: "%xero_consumer_secret%"
    rsa_private_key: "file://%kernel.root_dir%/Resources/Xero/private.pem"
  curl:
    CURLOPT_USERAGENT: XeroPHP Test App

Usage

Using the Xero service in your controller:

$xero = $this->get('fl_xero.app');

$contacts = $xero->load('Accounting\\Contact')->execute();
foreach ($contacts as $contact) {
    var_dump($contact);
}