Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

Differences Between: [Versions 310 and 311] [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 and 403]

(no description)

Copyright: (c) 2000-2013 John Lim (jlim#natsoft.com). All rights reserved.
Copyright: (c) 2014 Damien Regad, Mark Newnham and the ADOdb community
Version: v5.20.16 12-Jan-2020
File Size: 370 lines (10 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 2 files
 lib/adodb/adodb.inc.php
 lib/adodb/adodb-errorpear.inc.php

Defines 1 class

DB:: (7 methods):
  factory()
  connect()
  apiVersion()
  isError()
  isWarning()
  parseDSN()
  assertExtension()


Class: DB  - X-Ref

The main "DB" class is simply a container class with some static
methods for creating DB objects as well as some utility functions
common to all parts of DB.

factory($type)   X-Ref
Create a new DB object for the specified database type

param: $type string database type, for example "mysql"
return: object a newly created DB object, or a DB error code on

connect($dsn, $options = false)   X-Ref
Create a new DB object and connect to the specified database

param: $dsn mixed "data source name", see the DB::parseDSN
param: $options mixed if boolean (or scalar), tells whether
return: object a newly created DB connection object, or a DB

apiVersion()   X-Ref
Return the DB API version

return: int the DB API version number

isError($value)   X-Ref
Tell whether a result code from a DB method is an error

param: $value int result code
return: bool whether $value is an error

isWarning($value)   X-Ref
Tell whether a result code from a DB method is a warning.
Warnings differ from errors in that they are generated by DB,
and are not fatal.

param: $value mixed result value
return: bool whether $value is a warning

parseDSN($dsn)   X-Ref
Parse a data source name

param: $dsn string Data Source Name to be parsed
author: Tomas V.V.Cox <cox@idecnet.com>
return: array an associative array with the following keys:

assertExtension($name)   X-Ref
Load a PHP database extension if it is not loaded already.

param: $name the base name of the extension (without the .so or
return: bool true if the extension was already or successfully