loduis/alegra-php

Alegra PHP Library

Alegra PHP bindings

You can sign up for a Alegra account at http://www.alegra.com/., _(*1)

Requirements

PHP 5.6.11 and later., _(*2)

Composer

You can install the bindings via Composer. Run the following command:, _(*3)

composer require "loduis/alegra-php:@dev"

To use the bindings, use Composer's autoload:, _(*4)

require_once('vendor/autoload.php');

Dependencies

The bindings require the following extension in order to work properly:, _(*5)

• curl, although you can use your own non-cURL client if you prefer
• json
• mbstring (Multibyte String)

If you use Composer, these dependencies should be handled automatically. If you install manually, you'll want to make sure that these extensions are available., _(*6)

Getting Started

Any resource containts five main methods (all, get, create, save, delete), _(*7)

Simple usage looks like:, _(*8)

Your composer.json file, _(*9)

{
    "minimum-stability": "dev",
    "prefer-stable": true,
    "require": {
        "loduis/alegra-php": "1.0.*"
    }
}

Your test.php script, _(*10)

<?php

require './vendor/autoload.php';

Alegra\Api::auth('Your user', 'Your api token');
// Also you can auth api with your app credentials
/*
Alegra\Api::auth([
    'username' => 'Your user',
    'password' => 'Your password'
]);
*/

Create an new resource, _(*11)

$contact = Alegra\Contact::create(['name' => 'Your contact name']);
print_r($contact);

// Create using save

$contact = new Alegra\Contact;
$contact->name = 'My second contact';
$contact->save(); // Update the contact
print_r($contact);

Get an existing resource, _(*12)

$contact = Alegra\Contact::get(100); // where 100 is the id of resource.
$contact->identification = '900.123.123-8';
$contact->email = 'email@server.com';
$contact->save();
print_r($contact);

Save an resource without fetch your data, _(*13)

$contact = new Alegra\Contact(100);
$contact->email = 'user@server.com';
$contact->save();

Get all resources, _(*14)

$contacts = Alegra\Contact::all();
$contacts->each(function ($contact) {
    print_r($contact);
});

// $contacts is instanceof Illuminate\Support\Collection
// You can use methods like
print_r($contacts->slice(0, 3)); // The three first contacts.

Delete an resource, _(*15)

// Get a delete

Alegra\Contact::get(1)->delete();

// Delete without fetch data

(new Alegra\Contact(1))->delete();

// Delete using static interface

Alegra\Contact::delete(1);

Catch errors, _(*16)

try {
    // Your request code
}

// Exception when a client error is encountered (4xx codes)

catch (GuzzleHttp\Exception\ClientException $e) {
    // code
}

// Exception when a server error is encountered (5xx codes)

catch (GuzzleHttp\Exception\ServerException $e) {
    // code
}

// Exception thrown when a connection cannot be established.

catch (GuzzleHttp\Exception\ConnectException $e) {
    // code
}

// Other exceptions

catch (Exception $e) {
    // code
}

Documentation

Please see http://developer.alegra.com/docs for up-to-date documentation., _(*17)