Database Abstraction Layer for PHP https://www.adodb.org/dokuwiki/ 2026-05-17T02:04:48+00:00 https://www.adodb.org/dokuwiki/ https://www.adodb.org/dokuwiki/lib/exe/fetch.php?media=logo.png text/html 2022-06-09T16:37:24+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:active_record_tutorial&rev=1654792644&do=diff Active Record Tutorial Original Author Credit John Lim Chris Ravenscroft Overview This tutorial shows basic usage of the ADODB Active Record Feature. It relies on a MySQL database, and each script needs to include the code shown here, in order to initialize the tables. text/html 2022-06-09T16:37:24+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:activerecord_index&rev=1654792644&do=diff ADOdb Active Record ADOdb Active Record Introduction ADOdb Active Record is an Object Relation Mapping (ORM) implementation using PHP. In an ORM system, the tables and rows of the database are abstracted into native PHP objects. This allows the programmer to focus more on manipulating the data and less on writing SQL queries. text/html 2016-01-13T01:15:41+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:belongsto&rev=1452647741&do=diff belongsTo This function is deprecated. Use ClassBelongsTo/TableBelongsTo/TableKeyBelongsTo instead. Syntax void belongsTo( string $relationName, string $foreignKey, optional string $parentPrimaryKey = 'id' ) Description This function is the older way to define the parent of the current object. text/html 2019-01-01T00:31:29+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:classbelongsto&rev=1546302689&do=diff classBelongsTo Syntax void ADODB_Active_Record::classBelongsTo( string $childClass, string $parentClass, string $foreignKey, optional string $parentPrimaryKey = 'id', optional string $parentClass = 'ADODB_Active_Record' ) Description text/html 2016-01-13T01:15:42+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:classhasmany&rev=1452647742&do=diff classHasMany Syntax void ADODB_Active_Record::classHasMany( string $parentTable, string $childTable, optional string $foreignKey = '', optional string $foreignClass = 'ADODB_Active_Record' ) ---------- Description Globally defines a one-to-many relationship. Once defined, the relationship persists for the life of the script. text/html 2016-01-13T01:15:42+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:code_snippet_1&rev=1452647742&do=diff Setting the Database Connection The first step to using ADOdb_Active_Record is to set the default connection that an ADOdb_Active_Record objects will use to connect to a database. In addition, we will also create a temporary table to hold the data. The same table is used for each of the examples. text/html 2016-01-13T01:15:42+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:code_snippet_2&rev=1452647742&do=diff ActiveRecord Code Sample /* * Include the previously defined code snippet */ class person extends ADOdb_Active_Record{} $person = new person(); echo "<p>Output of getAttributeNames: "; var_dump($person->getAttributeNames()); /** * Outputs the following: * array(4) { * [0]=> * string(2) "id" * [1]=> * string(9) "name_first" * [2]=> * string(8) "name_last" * [3]=> * string(13) "favorite_color" * } */ $person = new person(); $person->name_first = 'Andi'; … text/html 2022-06-09T19:14:20+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:dbat&rev=1654802060&do=diff $_dbat TypeStringDefaultNULL Description Setting the value of this class variable forces the class to use the specified database connection for a class. Form more information on this, see ADOdb_Active_Record::setDatabaseAdaptor(). There is normally no need to use this unless multiple database connections have been configured. text/html 2016-01-13T01:15:43+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:extended_active_record_tutorial&rev=1452647743&do=diff Active Record eXtended This is the original one-to-many Active Record implementation submitted by Chris Ravenscroft (chris#voilaweb.com). The reason why we are offering both versions is that the Extended version is more powerful but more complex. My personal preference is to keep it simpler, but your view may vary. text/html 2025-10-05T00:20:18+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:find&rev=1759623618&do=diff find Syntax array|bool find( string $where optional string $bindarr=false, optional string $pkeysArr=false, optional array $extra=array() ) Description This function locates records the match the where string in any portion of the database record and returns an array of results. text/html 2025-06-01T11:21:07+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:getactiverecords&rev=1748776867&do=diff getActiveRecords Syntax bool getActiveRecords( string $tableName, optional string $where=false, optional mixed[] $bindarr=false, optional mixed[] $primaryKeyArray=false ) ---------- Description This method retrieves an array of ADOdb_Active_Records. text/html 2025-06-01T11:21:06+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:getactiverecordsclass&rev=1748776866&do=diff getActiveRecordsClass Syntax void getActiveRecordsClass( string $class, string $tableName, optional string $where=false, optional mixed[] $bindarr=false, optional mixed[] $primaryKeyArray=false, optional mixed[] $queryExtras=array(), optional mixed[] $relationsData=array() ) text/html 2018-07-02T12:19:55+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:getattributenames&rev=1530533995&do=diff getAttributeNames Syntax mixed[] getAttributeNames() Description This method returns the names of the columns in the table associated with an Active Record object. Usage $db->execute("CREATE TEMPORARY TABLE `persons` ( `id` int(10) unsigned NOT NULL auto_increment, `name_first` varchar(100) NOT NULL default '', `name_last` varchar(100) NOT NULL default '', `favorite_color` varchar(100) NOT NULL default '', P… text/html 2016-01-13T01:15:54+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:hasmany&rev=1452647754&do=diff hasMany This method is deprecated, use classHasMany / tableHasMany / tableKeyHasMany instead. Syntax void hasMany( string $relation, optional string $foreignKey = '' ) Description The deprecated method was used to define a one-to-many relationship Usage In this example we have 2 tables, persons (parent table) and children (child table) linked by persons.id = children.person_id. The variable $person text/html 2016-01-13T03:03:46+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:index&rev=1452654226&do=diff ADOdb Active Record Pages in this namespace: * $_dbat * $_quoteNames * $_table * $_where * $lockMode * Active Record eXtended * Active Record Tutorial * ActiveRecord Code Sample * ADOdb Active Record * belongsTo * classBelongsTo * classHasMany * find * getActiveRecords * getActiveRecordsClass * getAttributeNames * hasMany * lastInsertId * load * loadRelations * replace * save * set * setDatabaseAdapter * Setting the Database Connection * tableBelongsTo * tableHasMa… text/html 2016-01-13T01:15:46+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:lastinsertid&rev=1452647746&do=diff lastInsertId Syntax int lastInsertID( resource &$db, string $fieldname ) Description This function returns the last insert id from the specified database. text/html 2018-09-22T13:43:14+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:load&rev=1537623794&do=diff load See Also execute Syntax bool load( optional string $where='', optional mixed[] $bindVariables = false ) Description Loads a record from the database. If an error occurs, or no records are found it returns false, otherwise true. ---------- text/html 2016-01-18T23:27:46+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:loadrelations&rev=1453159666&do=diff loadRelations Syntax void LoadRelations( string $relation, optional string $whereOrderBy = ' ', optional int $offset = -1, optional int $limit = -1 ) Description Loads a subset of data into the class. The optional $offset and $limit parameters match the parameters defined in text/html 2016-01-13T01:15:54+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:lockmode&rev=1452647754&do=diff $lockMode TypeStringDefault' for update ' Description Setting the value of this class variable adds the value to SELECT statements executed by load. This value is the default for MySQL databases, but may need to be changed for others. Usage In this example we want to text/html 2018-07-20T22:52:29+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:quotenames&rev=1532127149&do=diff $_quoteNames ADOdb Active Record also honors the $ADODB_QUOTE_FIELDNAMES global variable in ADOdb V5.21. You can also use any of the parameters described there against the $_quoteNames variable TypeBooleanDefaultfalse Description Setting the value of this class variable to true causes the names of tables and columns to be quoted on insert and update statements, typically used because the names themselves contain reserved words or special characters text/html 2016-01-13T01:15:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:replace&rev=1452647747&do=diff replace bool replace() Description ADOdb supports replace functionality, whereby the record is inserted if it does not exists, or updated otherwise. Returns The method returns ValueDescription0failure1update2insert Usage $rec = new ADOdb_Active_Record("product"); $rec->name = 'John'; $rec->tel_no = '34111145'; $ok = $rec->replace(); ADOdb_Active_Record::Load($where) text/html 2016-01-13T01:15:48+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:save&rev=1452647748&do=diff save Syntax bool save() Description To insert a new record into the database, change an object's properties and then call the save() method. The method saves a record by executing an INSERT or UPDATE SQL statement as appropriate. Returns ValueDescription text/html 2016-01-13T01:15:48+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:set&rev=1452647748&do=diff set Syntax bool set() Description The method set() converts an array to an ADOdb_Active_Record. The array must be numerically indexed, and have all fields of the table defined in the array. The elements of the array must be in the table's natural order too. text/html 2022-06-09T16:15:04+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:setdatabaseadapter&rev=1654791304&do=diff setDatabaseAdapter See Also $_dbat Class Variable Syntax bool ADODB_Active_Record::setDatabaseAdapter( resource $database, optional string $label='' ) Description This links the Active Record class to an ADOdb database connection. The method returns true if it is a valid connection, or false if not. text/html 2016-01-13T01:15:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:table&rev=1452647749&do=diff $_table TypeStringDefaultNULL Description Setting the value of this class variable overrides the name of the database table associated with the Active Record set. Usage In the example below, an Active Record class called person is not associated with a table called text/html 2016-01-13T01:15:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:tablebelongsto&rev=1452647749&do=diff tableBelongsTo Syntax void ADODB_Active_Record::TableBelongsTo( string $childTable, string $relationName, string $foreignKey, optional string $parentPrimaryKey = 'id', optional string $parentClass = 'ADODB_Active_Record' ) ---------- text/html 2016-01-13T01:15:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:tablehasmany&rev=1452647749&do=diff tableHasMany void ADODB_Active_Record::tableHasMany( string $parentTable, string $childTable, optional string $foreignKey = '', optional string $foreignClass = 'ADODB_Active_Record' ) Description For some classes, the mapping between class name and table name (which is the pluralised version) might not match. For example, the class name might be person, but the table name might be people text/html 2016-01-13T01:15:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:tablekeybelongsto&rev=1452647749&do=diff tableKeyBelongsTo Syntax void ADODB_Active_Record::tableKeyBelongsTo( string $childTable, string $childKey, string $relationName, string $foreignKey, string $parentPrimaryKey = 'id', string $parentClass = 'ADODB_Active_Record' ) text/html 2016-01-13T01:15:50+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:tablekeyhasmany&rev=1452647750&do=diff tableKeyHasMany Syntax void ADODB_Active_Record::tableKeyHasMany( string $parentTable, string $parentTablePrimaryKey, string $childTable, optional string $foreignKey = ' ', optional string $foreignClass = 'ADODB_Active_Record' ) Description text/html 2016-01-13T01:15:54+00:00 Anonymous (anonymous@undisclosed.example.com) https://www.adodb.org/dokuwiki/doku.php?id=v5:activerecord:where&rev=1452647754&do=diff $_where TypeStringDefaultNULL Description Setting the value of this class variable sets a default where filter for the load operation. Usage In this example we always require a filter of type_code=1 for the operation. class person extends ADOdb_Active_Record { public $_where = ' type_code=1 '; }