------------------------------------------------------------------------------
exist_phpapi - eXist XML database library
------------------------------------------------------------------------------
Author:                        Eric Hanson <eric@aquameta.com>
                               http://www.aquameta.com/~eric/
Inspiration:                   Andrew Jenks <ajenks14@yahoo.com>
Version:                       0.8
Date:                          February 28, 2005
Status:                        alpha - briefly tested - a few known bugs
License:                       GPL
Music of choice while coding:  New Pornographers, Garden State Sdtk, Police


Description:
A (mostly) full implementation of the eXist XML database XML-RPC API.


Usage:
Connect to an eXist server with something like:

	<?php
	require_once "../exist_phpapi.inc";

	// connect to the XML databasesup
	$db = new eXist ("/exist/xmlrpc", "your.exist.server.hostname", 8080);
	$db->setCredentials ("admin", "");

	// optional stuff
	$db->setDebug (false);
	$db->setParamIndent (true);
	$db->setParamEncoding ("ISO-8859-1");
	?>
	
Then you can start making API calls:

	<?php
	$collection = "/db/foo";
	$result = $db->createCollection ($collection);
	if (!$result)
		die ("createCollection failed: ".$db->getError ());
	else 
		print "<p>Successful:  $collection created.";
	?>
	
	etc...
	
For the full API, see the exist_phpapi.inc file.  For example usage of
methods, see tests/test-all.php



Tests

There's a collection of tests you can run in the ./tests/ subdirectory, the
file test-all.php.  It creates a randomly named collection in a remote
server, puts a few files in it, queries the files, creats a user, and then
(hopefully) cleans up after itself.  It's here so you can see how things
work, and if they're working at all.  To run the tests, just browse to the
test-all.php file from your browser.


Requirements

PHP XML-RPC library from Useful Inc, included in the distribution under the
./inc/ directory.  eXist XML database, of course.


Links

eXist                   http://www.exist-db.org/
method docs             http://exist-db.org/devguide.html#N105A6
xmlrpc                  http://xmlrpc.usefulinc.com/doc/apidocs.html