StoredObject
A base class that contains tools for storing and retrieving objects from a database
Located in /include/classes/storeable-objects/StoredObject.inc (line 27)
What fields are out of date with the DB
Storeable member variables
Mapping member variabbles to column(s) in the DB's table(s)
Acts as DB primary key
Order in which tables should be processed
List of tables in the DB that the subtype uses
Inverse mapping of StoredObject::$fieldsToTables
Register a table with the Object Relational Mapper.
Normally used in the constructor of a subtype to configure the table->fields mapping.
Generic Getter.
Returns the value of the requested member variable.
Get Primary Key.
Returns the value of the object's database primary key
Generate a select statement for a given table.
Generates a select statement, selecting all registered columns from a given single table, by the tables's primary key columnm.
INSERTS the object to the Database.
INSERTS into the database to bring the db upto date with the state of the object. Does NOT do any checking for stale data.
Save/Update the object to the Database.
Either INSERTS or UPDATES, as appropriate, into the database to bring the db upto date with the state of the object. Does NOT do any checking for stale data.
Clears the status of all dirty bits to reflect clean status.
Remove this stored object from the database.
Completely remove this stored object from the database. This method relies on the the ON DELETE behavoir of the referenced tabes to work. Only the row referenced by the primeField is deleted, directly.
De-Register a table with the Object Relational Mapper.
Provided for symmetry -- never used I beleive....
Load the identified records into memory.
Fetch the referenced object from the database. If an $id is passed in use that, if not, attempt to use $this->getID, if neither fail.
Search on non-key data.
Searches for matching record(s) using whatever fields have been set.
Generic Setter.
Updates the referenced member variable to the new value and sets the dirty bit for the member variable.
Prime ID Setter.
Normally only used to set the ID before called retrieve, support is questionable, probably broken for changing an items primary key via this.
UPDATES the object to the Database.
UPDATES into the database to bring the db upto date with the state of the object. (This can include some INSERTS/DELETES when dealingn with multi-valued variables -- aka lists.
Documentation generated on Tue, 25 Apr 2006 13:11:11 -0400 by phpDocumentor 1.3.0RC3