PHP-PDB: ToDo List

General
Main Page
Basic Use Custom Formats Extra Info Credits
Modules
Address Book Datebook DOC List Memo Pad MobileDB SmallBASIC Todo
Examples
Bookmark Test Spade Twister
SourceForge
Download Project Page Mailing Lists Bug Reporting

The todo module is mostly straightforward, and should be fairly easy to use.

If you install a database created with this class onto your handheld, it will overwrite the one that already exists on your handheld. This is because a new database will have the same name as the current database on your handheld and you can't change the name of the database otherwise the application won't work. This is obviously irritating -- please keep this in mind. An ideal use for this PHP class would be for talking to a conduit, where the conduit would upload the current data, the server would parse it and add/modify/delete entries with this class, the server would send the modified file back to the conduit, and the conduit would replace the device's database with the modified one.

Including into your program

include 'php-pdb.inc';
include 'modules/todo.inc';

Creating a new database

Since a todo list has a specified type, creator, and name, the class takes care of knowing what they are. Creation of a new database is a snap.

$DB = new PalmTodoList();

Writing the database

This is the same as the base class. See Basic Use for more information.

Loading the database

This is the same as the base class. See Basic Use for more information.

Category Support and Record Attributes

This supports categories and attributes. See Basic Use for more information.

Other functions

GetRecordRaw() SetRecordRaw(): Please see Basic Use for how to use these functions. You use both of these to get/set records in the database.
NewRecord(): Returns an array with some default data for a new Todo record. Does not actually add the record. Use SetRecordRaw() for that.

Record Format

The data for the GetRecordRaw and the data returned from SetRecordRaw is a specially formatted array, as detailed below. Optional values can be set to '' or not defined. If an optional value is anything else (including zero), it is considered to be set.

Key	Example	Description
Description	This is my todo	Short description of thing to do
Note	Extended information	[Optional] A note attached to the record
DueDate	2001-01-23	[Optional] Year, month, and day of when the item should be done
Priority	1	[Optional]Priority of the event ([1-5])
Completed	false	[Optional] True/false indicating whether the action was completed or not.

If description is not specified, then the string 'No description' will be used instead.

Example

// Write Example
$todo = new PalmTodoList();
$categories = array(1 => 'Visita', 'Fax', 'Correo');
$todo->SetCategoryList($categories);
$record = array('Description' => 'Enviar Fax',
'Note' => "25\nProbar palm",
'Priority' => 2);
$todo->SetRecordRaw($record);
$todo->SetRecordAttrib(2); // Category 2

$todo->GoToRecord('+1');
$record = array('Description' => 'Llamar a juan',
'Note' => '35',
'Completed' => true,
'DueDate' => '2002-5-31');
$todo->SetRecordRaw($record);
$todo->SetRecordAttrib(PDB_RECORD_ATTRIB_DIRTY |
PDB_RECORD_ATTRIB_PRIVATE | 0);
// Category 0, dirty, private

$fp = fopen('./pdbs/todo.pdb','wb');
$todo->WriteToFile($fp);
fclose($fp);

// Read Example
$pdb = new PalmTodoList();
$fp = fopen('./tdread.pdb', 'r');
$pdb->ReadFile($fp);
fclose($fp);

echo "Name: $pdb->Name \n";
echo "Type ID: $pdb->TypeID \n";
echo "Creator: $pdb->CreatorID \n";
echo "Attributes: $pdb->Attributes \n";
echo "Version: $pdb->Version \n";
echo "ModNum: $pdb->ModNumber \n";
echo "CreationTime: $pdb->CreationTime \n";
echo "ModTime: $pdb->ModificationTime \n";
echo "BackTime: $pdb->BackupTime \n";
echo 'NumRec: '.$pdb->GetRecordCount()." \n";
$recids = $pdb->GetRecordIDs();
$record1 = $pdb->GetRecordRaw($recids[0]);
$attrib = $pdb->GetRecordAttrib($recids[0]);
echo "record1 = $record1 \n";
echo "Desc: " . $record1['Description'] . " \n";
echo "Note: " . $record1['Note'] . " \n";
echo 'Due Date: ' . $record1['DueDate'] . " \n";
echo 'Cat: ' . $record1['Category'] . " \n";
$categories = $pdb->GetCategoryList();
echo "NumCat = " . count($categories) . " \n";
foreach ($categories as $k => $v) {
echo "categories[$k] = $v \n";
foreach ($categories[$k] as $key => $val) {
echo " categories[$k][$key] = $val ";
}
}