Documentation/Installation

You are here:

Error: Failed to load processor ShowPath
No macro or processor named 'ShowPath' found


Installation

Requirements

Creole requires PHP 5.0.x or 5.1.x. You must also have a supported RDBMS (MySQL, PostgreSQL, MS SQL Server, SQLite, Oracle, ODBC).

Obtaining

Release (PEAR)

The easiest way to get and install Creole is to use the PEAR installer. (The Jargon classes are a separate package when installing using PEAR installer.)

$> pear channel-discover pear.phpdb.org
$> pear install phpdb/creole
$> pear install phpdb/jargon

Assuming the above commands did not generate any errors, you are now finished installing Creole. See ((Creole Guide)) to get started.

Development

If you would like to get the latest sourcecode, please checkout a copy from SVN.

$> svn checkout http://svn.phpdb.org/creole/trunk creole

Setup (non-PEAR)

After downloading the source, place the creole/classes/creole directory on the PHP include_path -- either by copying the creole/classes/creole directory to a path on your include_path (e.g. /usr/local/lib/php), or by adding /path/to/creole/classes to your include_path.

For example, on a Unix system, you might do:

$> cd /path/to/creole
$> ln -s classes/creole /usr/local/lib/php/creole
$> ln -s classes/jargon /usr/local/lib/php/jargon

Of course if you later try to install the PEAR package of Creole you will encounter errors as it will try to install class files into the /usr/local/lib/php/creole directory.

Getting Started

To get started create a Connection:

<?php
require_once 'creole/Creole.php';
$conn = Creole::getConnection("sqlite://localhost/:memory:");

And then see the Creole Guide for how to perform queries and iterate over the results. Good luck!

If you have any problems, send a message to the user support mailing list.