Freetag for PHP4 - v0.260
  (c) 2004-2006 Gordon Luk (gluk at getluky dotto netto)
  http://freetag.googlecode.com
  Released under both New BSD and GNU Lesser GPL library license.
  For complete licensing terms, read href="http://freetag.googlecode.com/svn/trunk/license.txt

Description

Freetag is an easy tagging and folksonomy-enabled plugin for use with MySQL-PHP applications. It allows you to create tags on existing database schemas, and access and manage your tags through a robust API.

Requirements / Suitability

Freetag is designed for applications running on the LAMP (Linux, Apache, MySQL, PHP) stack. Theoretically, as long as you're using MySQL and PHP, it should work. If it does, let me know!

See below for tested versions.

Freetag should fit in well with most database schemas that have an integer as a primary key, but you should know the following limitations before you begin:

Freetag expects to reference unique integer keys for both objects to tag, and users who tag them. Freetag expects to reference integers for the two above as well.

Documentation

For a gentle introduction to Freetag along with implementation sample code, see the new Freetag Implementation Guide (PDF, 187KB)</a>.

Full API Documentation is available in the docs/ dir in the source tree.

Keep up-to-date!

The Freetag Google tracker will hold all bugs, requests, and roadmaps for Freetag. Visit it here:

http://code.google.com/p/freetag/issues/list

Please join the Yahoo! Group for group discussion and announcements about Freetag:

http://groups.yahoo.com/group/freetag/

I post news items fairly frequently on my personal blog. You can see them at:

http://getluky.net/tags/tech/freetag/

Installing / Usage

To install Freetag, download http://freetag.googlecode.com/files/freetag-v0.260.gz.

Unzip the file to an include directory outside of your public web structure.

tar xzvf freetag-v0.260.tar.gz

There will be two files of major interest:

freetag.class.php - The class file, which includes the freetag api. freetag.sql - A SQL script file to use to create your freetag tables in a MySQL database.

You can either use an existing database, or create a new database to store the tag information.

Freetag now supports passing all startup parameters via the freetag() constructor. You can construct an array of parameters and pass them as shown below:

require_once("freetag/freetag.class.php");

$freetag_options = array (
'debug' => FALSE,
'db_user' => '',
'db_pass' => '
',
'db_host' => 'localhost',
'db_name' => ''
);

$freetag = new freetag($freetag_options);

This is useful because you can install future versions of freetag without needing to re-edit the classfile with your instance's parameters!

For a complete listing of statup parameters, see the documentation for the constructor in the docs/ dir.

Import the table definitions by running the freetag.sql script file:

mysql -u username -p databasename < freetag.sql

After it runs, you're ready to include the freetag class in your PHP application!

You should identify the integer primary keys for the objects and users you want to tag with, and you will be ready to start using the API.

Upgrading

FROM > v02.02 to v0.250:

Simply unzip the tarfile over the existing version.

FROM v0.220 to v0.230 and v0.231:

Unzip the tarfile over the existing v0.220 version.

FROM v0.210 to v0.220:

Edit your freetag() invocation code to include an $options array with your database parameters. Unzip the tarfile over the existing v0.210 version.

FROM v0.202 to v0.210:

Replace freetag.class.php with the updated version. Re-edit your db connection parameters.

FROM v0.201 to v0.202:

Untar the package to a directory. Change your include() statements to the new directory. Run the update\0.201\to\0.202.sql script on your freetag database to add the new indexes. mysql -u username -p databasename < update\0.201\to\0.202.sql You're all set! Email me if you run into probs.

Donations / Contributions

Donations and Contributions of source code, documentation, testimonials, or money are all welcome and appreciated.

Regarding the ADODB Library used by Freetag:

ADODB Library for PHP4

(c) 2000-2004 John Lim (jlim@natsoft.com.my) Released under both BSD and GNU Lesser GPL library license. This means you can use it in proprietary products. For more info about ADOdb, visit http://adodb.sourceforge.net/ Please read the rest of the ADODB license terms in adodb/license.txt