tableau-mkt/elomentary

The simple PHP Eloqua REST API client; object oriented, tested, and documented for PHP 5.3+.

Elomentary

The simple, objected oriented wrapper for the Eloqua REST API., _(*1)

Features

• Follows PSR-4 conventions for friendly autoloading
• Extensively tested and documented

Requirements

• PHP >= 5.3.3 with cURL,
• Guzzle library,
• For developing and contributing: PHPUnit.

Installation

The best way to install Elomentary is via git and Composer!, _(*2)

Composer is a dependency manager for PHP. The easiest way to install Composer for *nix (including Mac):, _(*3)

curl -sS https://getcomposer.org/installer | php
mv composer.phar /usr/local/bin/composer

More detailed installation instructions for multiple platforms can be found in the Composer Documentation., _(*4)

Normal installation

# Download Elomentary
git clone https://github.com/tableau-mkt/elomentary.git elomentary
# Download dependencies
cd elomentary
composer update --no-dev

That's it! If you ever need to update Elomentary, just use the following commands:, _(*5)

# Update Elomentary
cd /path/to/elomentary
git pull
# Update Elomentary dependencies
composer update --no-dev

Development installation

If you want to contribute to Elomentary development, you'll want to download the dependencies for performing unit tests as well., _(*6)

# Make a projects directory if it doesn't already exist.
mkdir -p $HOME/libs
# Download Elomentary and development dependencies.
git clone https://github.com/tableau-mkt/elomentary.git $HOME/libs/elomentary
# Download dependencies.
composer update --working-dir $HOME/libs/elomentary

Autoloading

In day-to-day projects, you may want to require Elomentary using Composer's autoloader. You can add a requirement like so:, _(*7)

{
  "require": {
    "tableau-mkt/elomentary": "*"
  },
  "minimum-stability": "dev"
}

Basic usage

<?php

// This file is generated by Composer
require_once 'vendor/autoload.php';

$client = new \Eloqua\Client();
$client->authenticate('MySite', 'My.User', 'BatteryHorseStaple');
$contacts = $client->api('contacts')->search('*@example.com');

From $client, you can access all implemented Eloqua API services., _(*8)

Documentation

Detailed documentation is available in doc, located here., _(*9)