@@ -6,8 +6,8 @@ * * @package ActivePHP * @author OwlManAtt <owlmanatt@gmail.com> - * @copyright 2007, Yasashii Syndicate - * @version 2.3.0 + * @copyright 2007-2008, Yasashii Syndicate + * @version 2.4.0 */ class ActiveTable_Cache_APC implements ActiveTable_Cache { active_table/Cachers/apc.class.php @@ -7,8 +7,8 @@ * * @package ActivePHP * @author OwlManAtt <owlmanatt@gmail.com> - * @copyright 2007, Yasashii Syndicate - * @version 2.3.0 + * @copyright 2007-2008, Yasashii Syndicate + * @version 2.4.0 */ class ActiveTable_Cache_Globals implements ActiveTable_Cache { active_table/Cachers/globals.class.php @@ -4,8 +4,8 @@ * * @package ActivePHP * @author OwlManAtt <owlmanatt@gmail.com> - * @copyright 2007, Yasashii Syndicate - * @version 2.3.0 + * @copyright 2007-2008, Yasashii Syndicate + * @version 2.4.0 */ /** active_table/Cachers/interface.inc.php @@ -1,27 +1,38 @@ -=========================================== -=========================================== -==== README for ActiveTable ==== -=========================================== -=========================================== -=== Author: OwlManAtt === -=== Updated: 2007-08-16 === -=========================================== +===================================================== += _ _ _ ____ _ _ ____ = += / \ ___| |_(_)_ _____| _ \| | | | _ \ = += / _ \ / __| __| \ \ / / _ \ |_) | |_| | |_) | = += / ___ \ (__| |_| |\ V / __/ __/| _ | __/ = += /_/ \_\___|\__|_| \_/ \___|_| |_| |_|_| = +===================================================== += Author: Nicholas 'OwlManAtt' Evans = += Email: owlmanatt@gmail.com = += Updated: 2008-04-20 = += URL: http://aphp.yasashiisyndicate.org = +===================================================== == Overview == -ActivePHP (otherwise known as ActiveTable) is a very simple implementation of the Active Record pattern in PHP5. -Using ActiveTable, you can define a class that will automatically define setters/getters for columns and -provide you with the basic CRUD methods needed in any application. +ActivePHP (otherwise known as ActiveTable) is a very simple implementation of the Active Record +pattern in PHP5. Using ActiveTable, you can define a class that will automatically define +setters/getters for columns and provide you with the basic CRUD methods needed in any application. -ActivePHP supports MySQL and Oracle (8i and 9i have been tested). It uses the PEAR::DB abstraction layer for doing most of its work, so any limitations on what -database this library can interact with can be resolved easily; another SQL generation driver for your RDBMS of choice is all that is needed. +ActivePHP supports MySQL and Oracle (8i and 9i have been tested). It uses the PEAR::DB abstraction +layer for doing most of its work, so any limitations on what database this library can interact +with can be resolved easily; another SQL generation driver for your RDBMS of choice is all that +is needed. + +Documentation is available in-line as phpdoc blocks (and can be compiled into nice HTML pages), +and even more useful documentation is available at <http://aphp.yasashiisyndicate.org>. == Requirements == ActiveTable requires the following: * PHP 5 (5.1 preferred) * PEAR and the PEAR::DB and PEAR::Log packages. -* MySQL (4 or 5), Oracle (8i, 9i, or 10g) +* MySQL (4 or 5), Oracle (8i, 9i, or 10g), PostgreSQL (tested on 8.3, should work for + old versions too) * MySQL: Table(s) with an auto-incrememting primary key. + * PostgreSQL: Table(s) with an auto-incrementing primary key (a SERIAL column is fine) * Oracle uses the 'rowid' present in every table. == Use == active_table/README @@ -4,8 +4,8 @@ * * @package ActivePHP * @author OwlManAtt <owlmanatt@gmail.com> - * @copyright 2007, Yasashii Syndicate - * @version 2.3.0 + * @copyright 2007-2008, Yasashii Syndicate + * @version 2.4.0 */ /** @@ -13,7 +13,7 @@ * * @package ActivePHP * @author OwlManAtt <owlmanatt@gmail.com> - * @copyright 2007, Yasashii Syndicate + * @copyright 2007-2008, Yasashii Syndicate * @version Release: @package_version@ **/ class ActiveTable_SQL_MySQL implements ActiveTable_SQL active_table/SqlGenerators/mysql.class.php @@ -4,8 +4,8 @@ * * @package ActivePHP * @author OwlManAtt <owlmanatt@gmail.com> - * @copyright 2007, Yasashii Syndicate - * @version 2.3.0 + * @copyright 2007-2008, Yasashii Syndicate + * @version 2.4.0 */ /** @@ -13,7 +13,7 @@ * * @package ActivePHP * @author OwlManAtt <owlmanatt@gmail.com> - * @copyright 2007, Yasashii Syndicate + * @copyright 2007-2008, Yasashii Syndicate * @version Release: @package_version@ **/ class ActiveTable_SQL_Oracle implements ActiveTable_SQL active_table/SqlGenerators/oci.class.php @@ -4,8 +4,8 @@ * * @package ActivePHP * @author OwlManAtt <owlmanatt@gmail.com> - * @copyright 2007, Yasashii Syndicate - * @version 2.3.0 + * @copyright 2008, Yasashii Syndicate + * @version 2.4.0 */ /** active_table/SqlGenerators/pgsql.class.php @@ -4,8 +4,8 @@ * * @package ActivePHP * @author OwlManAtt <owlmanatt@gmail.com> - * @copyright 2007, Yasashii Syndicate - * @version 2.3.0 + * @copyright 2007-2008, Yasashii Syndicate + * @version 2.4.0 **/ /** @@ -32,10 +32,10 @@ require_once('Cachers/apc.class.php'); * * @package ActivePHP * @author OwlManAtt <owlmanatt@gmail.com> - * @copyright 2007, Yasashii Syndicate + * @copyright 2007-2008, Yasashii Syndicate * @version Release: @package_version@ */ -class ActiveTable +abstract class ActiveTable { /** * A PEAR::DB database connector. @@ -950,9 +950,26 @@ class ActiveTable * * *NOTE* - At this time, nesting and ORs are not supported. * + * As far as ORDER BY goes, you have two options: + * + * 1. SQL fragment (deprecated, don't do this with new code) + * 2. Normalized array that should look like so: + * + * <code> + * $ORDER_BY = array ( + * 'direction' => 'ASC|DESC', // either work + * 'columns' => array( + * array( + * 'table' => 'tablename', + * 'column' => 'id', + * ), + * ) + * ); + * </code> + * * @param array Things to search on. Everything is an AND and nesting * is not supported. - * @param string ORDER BY clause. + * @param string|array ORDER BY clause or an array structure specified above. * @param boolean Return count instead of results, true or false. * @throws SQLError If an invalid SQL statement is generated (usually due to * an invalid column name getting mogged in somewhere), @@ -1066,17 +1083,6 @@ class ActiveTable } else { - /* - * Array ( - * 'columns' => array( - * array( - * 'table' => 'tablename', - * 'column' => 'id', - * ), - * ) - * 'direction' => asc|desc - * ) - */ if(array_key_exists('direction',$order_by) == false) { throw new ArgumentError('No direction specified for ORDER BY.'); active_table/active_table.class.php @@ -5,7 +5,7 @@ * @package ActivePHP * @author OwlManAtt <owlmanatt@gmail.com> * @copyright 2007, Yasashii Syndicate - * @version 2.3.0 + * @version 2.4.0 **/ // Required parts - the exception library. @@ -15,7 +15,6 @@ $base_path = realpath(getcwd()); $MODULES = array( 'active_table', 'csvio', - 'dagg' ); foreach($MODULES as $module) aphp.php @@ -5,7 +5,7 @@ * @package ActivePHP * @author OwlManAtt <owlmanatt@gmail.com> * @copyright 2007, Yasashii Syndicate - * @version 2.3.0 + * @version 2.4.0 */ /** csvio/csvio.class.php @@ -4,8 +4,8 @@ * * @package ActivePHP * @author OwlManAtt <owlmanatt@gmail.com> - * @copyright 2007, Yasashii Syndicate - * @version 2.3.0 + * @copyright 2007-2008, Yasashii Syndicate + * @version 2.4.0 **/ /** exceptions.inc.php 1d838c64f45bb1b6e92397438b535b6a4df394fe Nicholas 'OwlManAtt' Evans owlmanatt@gmail.com http://github.com/OwlManAtt/activephp/commit/51ebaba05b4ef4c849fb5d2a300dff34281032bf 51ebaba05b4ef4c849fb5d2a300dff34281032bf 2008-04-20T18:18:06-07:00 2008-04-20T18:18:06-07:00 Documentation/tags updated. Inline documentation updated for findBy(), all of the version tags updated. 267f68445029a4218486d4867983a9aa40e0b633 Nicholas 'OwlManAtt' Evans owlmanatt@gmail.com