| 7 |
This module does not provide a Drupal graphical interface for communicating with Unfuddle, it is up to other modules |
This module does not provide a Drupal graphical interface for communicating with Unfuddle, it is up to other modules |
| 8 |
to invoke the API by using the classes provided. |
to invoke the API by using the classes provided. |
| 9 |
|
|
| 10 |
The module does provide an administration page for setting the default Unfuddle connection information such as URL, user, |
The module does provide an administration page for setting the default Unfuddle connection information such as URL, user, password and an optional project number. |
|
and password. |
|
| 11 |
|
|
| 12 |
-- USAGE -- |
-- USAGE -- |
| 13 |
|
|
| 14 |
The Unfuddle API Drupal module is class-based, all interactions with the Unfuddle API happen through methods of the Unfuddle class. |
The Unfuddle API Drupal module is class-based, all interactions with the Unfuddle API happen through methods of the Unfuddle class. |
| 15 |
|
|
| 16 |
To use the Unfuddle class you call the function unfuddle_api_create() which returns an instantiated Unfuddle object. Unfuddle's API is |
To use the Unfuddle class you use $unfuddle = new Unfuddle(); which gives you an instantiated Unfuddle object. Unfuddle's API is |
| 17 |
now available as methods of the object. Details on the API can be found on Unfuddle.com at http://unfuddle.com/docs/api. |
now available as methods of the object. Details on the API can be found on Unfuddle.com at http://unfuddle.com/docs/api. |
| 18 |
|
|
| 19 |
For example, to get the projects you would need only the following two lines of code: |
For example, to get the projects you would need only the following two lines of code: |
| 20 |
$unfuddle = unfuddle_api_create(); |
$unfuddle = new Unfuddle(); |
| 21 |
$projects = $unfuddle->getProjects(); |
$projects = $unfuddle->getProjects(); |
| 22 |
|
|
| 23 |
To create a ticket you invoke the createTicket() method. Refer to inline documentation on required parameters. |
To create a ticket you invoke the createTicket() method. Refer to inline documentation on required parameters. |
| 24 |
$response = $unfuddle->createTicket(<parameters>); |
$response = $unfuddle->createTicket(<parameters>); |
| 25 |
|
|
| 26 |
The Unfuddle class defaults to using the connection data stored in the Drupal database but can be overridden by passing a URL, username, |
The Unfuddle class defaults to using the connection data stored in the Drupal database but can be overridden by passing a URL, username, |
| 27 |
and password to the unfuddle_api_create() function or by invoking methods setURL() and setAuth() on an instantiated object. |
and password to the class: new Unfuddle($url, $user, $pass, $project); or by invoking methods setURL() and setAuth() on an instantiated object. |
| 28 |
|
|
| 29 |
-- CREDITS -- |
-- CREDITS -- |
| 30 |
|
|
| 31 |
Written by Ben Jeavons (drupal.org username coltrane) from code originally by Andy Kirkham and later modified by Matt Tucker. Inspiration |
Written by Ben Jeavons (drupal.org username coltrane) from code originally by Andy Kirkham and later modified by Matt Tucker and Jody Hamilton. Inspiration |
| 32 |
for class by the Drupal Twitter module. |
for class by the Drupal Twitter module. |
| 33 |
|
|
|
$Id: README.txt,v 1.1 2009/07/27 15:02:14 coltrane Exp $ |
|
| 34 |
|
$Id: README.txt,v 1.2 2009/07/29 15:57:45 coltrane Exp $ |