Giter VIP home page Giter VIP logo

elomentary's Introduction

Elomentary Build Status Code Climate Test Coverage Dependency Status

The simple, objected oriented wrapper for the Eloqua REST API.

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!

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.

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:

# 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.

# 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:

{
  "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.

Documentation

Detailed documentation is available in doc, located here.

elomentary's People

Contributors

iameap avatar pvarney-netpx avatar jtwalters avatar portermi avatar jkopel avatar vutran avatar

Watchers

Dustin Simpson avatar James Cloos avatar Brady Roberts avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.