The simple, objected oriented wrapper for the Eloqua REST API.
- Follows PSR-4 conventions for friendly autoloading
- Extensively tested and documented
The best way to install Elomentary is via git and Composer!
Composer is a dependency manager for PHP. The easiest way to install Composer for *nix (including Mac):
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.
# 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:
# Update Elomentary
cd /path/to/elomentary
git pull
# Update Elomentary dependencies
composer update --no-dev
If you want to contribute to Elomentary development, you'll want to download the dependencies for performing unit tests as well.
# 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
In day-to-day projects, you may want to require Elomentary using Composer's autoloader. You can add a requirement like so:
{
"require": {
"tableau-mkt/elomentary": "*"
},
"minimum-stability": "dev"
}
<?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.
Detailed documentation is available in doc
, located here.