fORM

Takes a table and turns it into a class name - uses custom mapping if set

Will dynamically create an fActiveRecord-based class for a database table

Normally this would be called from an __autoload() function.

This method will only create classes for tables in the default ORM database.

Enables caching on the fDatabase, fSQLTranslation and fSchema objects used for the ORM

This method will cache database schema information to the three objects that use it during normal ORM operation: fDatabase, fSQLTranslation and fSchema. To allow for schema changes without having to manually clear the cache, all cached information will be cleared if any fUnexpectedException objects are thrown.

This method should be called right after fORMDatabase::attach().

Sets a class to use a database other than the "default"

Multiple database objects can be attached for the ORM by passing a unique $name to the attach() method.

Allows non-standard class to table mapping

By default, all database tables are assumed to be plural nouns in underscore_notation and all class names are assumed to be singular nouns in UpperCamelCase. This method allows arbitrary class to table mapping.

Allows overriding of default column names

By default a column name is the result of fGrammar::humanize() called on the column.

Allows overriding of default record names

By default a record name is the result of fGrammar::humanize() called on the class.

Registers a callback for an fActiveRecord method that falls through to fActiveRecord::__call() or hits a predefined method hook

The callback should accept the following parameters:

• $object: The fActiveRecord instance
• &$values: The values array for the record
• &$old_values: The old values array for the record
• &$related_records: The related records array for the record
• &$cache: The cache array for the record
• $method_name: The method that was called
• &$parameters: The parameters passed to the method

Registers a callback for one of the various fActiveRecord hooks - multiple callbacks can be registered for each hook

The method signature should include the follow parameters:

• $object: The fActiveRecord instance
• &$values: The values array for the record - see the $values documentation for details
• &$old_values: The old values array for the record - see the $old_values documentation for details
• &$related_records: The related records array for the record - see the $related_records documentation for details
• &$cache: The cache array for the record - see the $cache documentation for details

The 'pre::validate()' and 'post::validate()' hooks have an extra parameter:

• &$validation_messages: An ordered array of validation errors that will be returned or tossed as an fValidationException - see the $validation_messages documentation for details

The 'pre::replicate()', 'post::replicate()' and 'cloned::replicate()' hooks have an extra parameter:

• $replication_level: An integer representing the level of recursion - the object being replicated will be 0, children will be 1, grandchildren 2 and so on.

Below is a list of all valid hooks:

• 'post::__construct()'
• 'pre::delete()'
• 'post-begin::delete()'
• 'pre-commit::delete()'
• 'post-commit::delete()'
• 'post-rollback::delete()'
• 'post::delete()'
• 'post::loadFromIdentityMap()'
• 'post::loadFromResult()'
• 'pre::populate()'
• 'post::populate()'
• 'pre::replicate()'
• 'post::replicate()'
• 'cloned::replicate()'
• 'pre::store()'
• 'post-begin::store()'
• 'post-validate::store()'
• 'pre-commit::store()'
• 'post-commit::store()'
• 'post-rollback::store()'
• 'post::store()'
• 'pre::validate()'
• 'post::validate()'

Registers a callback to modify the results of fActiveRecord::inspect() methods

Registers a callback for when objectify() is called on a specific column

Registers a callback for an fRecordSet method that fall through to fRecordSet::__call()

The callback should accept the following parameters:

• $object: The actual record set
• $class: The class of each record
• &$records: The ordered array of fActiveRecord objects
• $method_name: The method name that was called
• $parameters: Any parameters passed to the method

Registers a callback to modify the results of fActiveRecord::reflect()

Callbacks registered here can override default method signatures and add method signatures, however any methods that are defined in the actual class will override these signatures.

The callback should accept three parameters:

• $class: the class name
• &$signatures: an associative array of {method_name} => {signature}
• $include_doc_comments: a boolean indicating if the signature should include the doc comment for the method, or just the signature

Registers a callback for when a value is replicated for a specific column

Registers a callback for when scalarize() is called on a specific column

Takes a class name (or class) and turns it into a table name - Uses custom mapping if set