Login   Register  
PHP Classes
elePHPant
Icontem

File: README.md

Recommend this page to a friend!
Stumble It! Stumble It! Bookmark in del.icio.us Bookmark in del.icio.us
  Classes of Daniel Costa  >  Dreamhost  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/plain
Description: Documentation
Class: Dreamhost
Manage Dreamhost hosting accounts using its API
Author: By
Last change: Merge branch 'master' of github.com:danielcosta/php-dreamhost
Adding travis-ci build status seal to Readme.md
Date: 1 year ago
Size: 1,454 bytes
 

Contents

Class file image Download
PHP class for the Dreamhost API [![Build Status](https://travis-ci.org/danielcosta/php-dreamhost.png?branch=master)](https://travis-ci.org/danielcosta/php-dreamhost)
===============================

Interfaces with the Dreamhost API

Installation
------------

Package available on [Composer](http://packagist.org/packages/danielcosta/php-dreamhost). Autoloading is [PSR-0](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md) compatible.

Usage
-----
	
	<?php
	
	use DanielCosta\Dreamhost;

    $dh = new Dreamhost('your api key'[,format]);
    $dh->exec('command'[, array(arg => value[, ...])]);

Where *__'command'__* is one of the many listed on the [Dreamhost Wiki API](http://wiki.dreamhost.com/API/Api_commands) article.

Method *__'exec'__* returns either an array of associative arrays of the data returned by Dreamhost or throws an exception upon error.

You can define any preferred return format by passing a second argument to class constructor. Defaults to 'json'.

Example
-------

	<?php
	
	use DanielCosta\Dreamhost;
    
    $dh = new Dreamhost('6SHU5P2HLDAYECUM'[,format]);

    try {
    	$method = 'api-list_accessible_cmds';
        $commands = $dh->exec($method);
        // $commands = $dh->$method(); // this should also work
        print_r($commands);
    } catch (Exception $e) {
        echo $e->getMessage(); // contains either the error data returned by dreamhost or a curl error string and number
    }