cheddar-getter/client

The official PHP client for the CheddarGetter API

1.2.1 2020-10-18 13:08 UTC

Suggests

• ext-curl: *
• zendframework/zend-http: *
• zendframework/zendframework1: *

MIT

• Marc Guyer

• CheddarGetter

README

Via Composer

1. Get Composer
2. Learn Composer
3. Define the requirement in your project composer.json file:

"require": {
	"cheddar-getter/client": "*"
}

1. Run composer install from your command line.
2. Make sure you either have the cUrl extension installed in your PHP build or Zend_Http_Client (ZF1) is available via autoload. Our composer.json only suggests these packages but one or the other is required unless you build your own HTTP adapter (see below).

As a Git submodule

git clone git://github.com/marcguyer/cheddargetter-client-php.git /path/to/includepath/CheddarGetter

The 'CheddarGetter' directory must not exist prior to running the above command.

Just download it, geez

Download and unzip the files and put them in a directory called /path/to/includepath/CheddarGetter

Basic Usage

Instantiate the Client Object

<?php
	$client = new CheddarGetter_Client(
		'https://[theurlforcheddargetter.com]',
		'[yourusername]',
		'[yourpassword]',
		'[yourproductcode]'
	);
?>

Create a Customer

<?php
  $data = array(
    'code'      => 'EXAMPLE_CUSTOMER',
    'firstName' => 'Example',
    'lastName'  => 'Customer',
    'email'     => '[e-mail]',
    'subscription' => array(
      'planCode'      => 'THE_PLAN_CODE',
      'ccFirstName'   => 'Example',
      'ccLastName'    => 'Customer',
      'ccNumber'      => '4111111111111111',
      'ccExpiration'  => '04/2011'
    )
  );

  $customer = $client->newCustomer($data);
	print_r($customer->toArray());
	echo $customer->toJson();
?>

Get a Customer

<?php
	$customer = $client->getCustomer('EXAMPLE_CUSTOMER');
	print_r($customer->toArray());
	echo $customer->toJson();
?>

Error Handling

CheddarGetter_Client throws CheddarGetter_Client_Exception containing the error information.

CheddarGetter_Response throws CheddarGetter_Response_Exception containing the error information.

If the CheddarGetter API returns an error document, a CheddarGetter_Response_Exception is thrown. This can happen during the normal course of operation and the error data in the exception should be presented to the user or handled according to your specs. Here's a quick and dirty example:

<?php
$data = array(
  'code'      => 'EXAMPLE_CUSTOMER',
  'firstName' => 'Example',
  'lastName'  => 'Customer',
  'email'     => '[e-mail]',
  'subscription' => array(
    'planCode' => 'A_PAID_PLAN',
    'ccFirstName'   => 'Example',
    'ccLastName'        => 'Customer',
    'ccNumber'      => '4111111111111111',
    'ccExpiration'  => '04/2011'
  )
);
try {
	$customer = $client->newCustomer($data);
	// under some circumstances, the customer is created but
	// contains an embedded error that needs to be handled
	$customer->handleEmbeddedErrors();
} catch (CheddarGetter_Response_Exception $re) {
  die($re->getCode() . '-' . $re->getAuxCode() . ': ' . $re->getMessage());
}
?>

More information about errors is available in the Error Handling knowledge base article. You can and should test by simulating the possible errors.

Advanced Usage

The adapter pattern (thanks to https://github.com/stof) is used so you can specify your own http adapter and/or super globals access adapter. The default built-in adapters use cUrl for http communication, and super globals are accessed directly. Also included are Zend Framework compatible adapters. If you've created an adapter of your own that should be included, just send us a pull request from your fork. Here's an example using a custom HTTP adapter:

<?php
	$client = new CheddarGetter_Client(
		'https://theurlforcheddargetter.com',
		'[yourusername]',
		'[yourpassword]',
		'[yourproductcode]',
		new MyHTTPAdapter()
	);
	$customers = $client->getCustomers();
	print_r($customers->toArray());
	echo $customers->toJson();
?>

Specify a custom HTTP adapter

<?php
	CheddarGetter_Client::setHttpClient(
		new MyCustomClient()
	);
?>

Specify a custom super globals access adapter

<?php
	CheddarGetter_Client::setRequestAdapter(
		new MyCustomAdapter()
	);
?>

Contributing

Writing code

Pull requests are welcome! Please fork us, write and issue a pull request. Learn more about contributing to open source projects via GitHub

Asking questions

Support Forum

The best way to ask questions is via the CheddarGetter Support Forum.

GitHub Issues

You're also welcome to open a new issue if your inquiry is of a technical nature or you think you've found a bug.

Documentation

Check 'em out in the /docs directory or as hosted on GitHub: http://marcguyer.github.io/cheddargetter-client-php/

Also, raw API docs are here: http://cheddargetter.com/developers