From a0eb2e97f9054c623541978e746dfacb22eb9f10 Mon Sep 17 00:00:00 2001 From: Aparup Banerjee Date: Fri, 20 Jan 2012 14:39:49 +0800 Subject: [PATCH] MDL-30972 Documentation : Renamed DB engine drivers to "@package core" but moodle_*.php are "@subpackage dml_driver", all other dml/*.php are "@subpackage dml". --- lib/dml/database_column_info.php | 3 ++- lib/dml/moodle_database.php | 1 + lib/dml/moodle_recordset.php | 1 + lib/dml/moodle_temptables.php | 1 + lib/dml/moodle_transaction.php | 2 ++ lib/dml/mssql_native_moodle_database.php | 7 +++++- lib/dml/mssql_native_moodle_recordset.php | 2 +- lib/dml/mssql_native_moodle_temptables.php | 2 +- lib/dml/mysqli_native_moodle_database.php | 7 +++++- lib/dml/mysqli_native_moodle_recordset.php | 7 +++++- lib/dml/mysqli_native_moodle_temptables.php | 2 +- lib/dml/oci_native_moodle_database.php | 26 ++++++++++++++------- lib/dml/oci_native_moodle_package.sql | 2 +- lib/dml/oci_native_moodle_recordset.php | 2 +- lib/dml/oci_native_moodle_temptables.php | 2 +- lib/dml/pdo_moodle_database.php | 7 +++++- lib/dml/pdo_moodle_recordset.php | 7 +++++- lib/dml/pgsql_native_moodle_database.php | 7 +++++- lib/dml/pgsql_native_moodle_recordset.php | 10 ++++++-- lib/dml/pgsql_native_moodle_temptables.php | 2 +- lib/dml/sqlite3_pdo_moodle_database.php | 7 +++++- lib/dml/sqlsrv_native_moodle_database.php | 7 +++++- lib/dml/sqlsrv_native_moodle_recordset.php | 4 ++-- lib/dml/sqlsrv_native_moodle_temptables.php | 13 +++++++---- 24 files changed, 99 insertions(+), 32 deletions(-) diff --git a/lib/dml/database_column_info.php b/lib/dml/database_column_info.php index 2f8cecdaa27..a6c762af07a 100644 --- a/lib/dml/database_column_info.php +++ b/lib/dml/database_column_info.php @@ -21,6 +21,7 @@ * * @package core * @category dml + * @subpackage dml * @copyright 2008 Petr Skoda (http://skodak.org) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ @@ -34,7 +35,7 @@ defined('MOODLE_INTERNAL') || die(); * 'column' does mean 'the field' here. * * @package core - * @category database + * @category dml * @copyright 2008 Petr Skoda (http://skodak.org) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/lib/dml/moodle_database.php b/lib/dml/moodle_database.php index 46af1a3cbef..69df996c30b 100644 --- a/lib/dml/moodle_database.php +++ b/lib/dml/moodle_database.php @@ -21,6 +21,7 @@ * * @package core * @category dml + * @subpackage dml * @copyright 2008 Petr Skoda (http://skodak.org) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/lib/dml/moodle_recordset.php b/lib/dml/moodle_recordset.php index d8ad0fbf385..d1e7005120a 100644 --- a/lib/dml/moodle_recordset.php +++ b/lib/dml/moodle_recordset.php @@ -21,6 +21,7 @@ * * @package core * @category dml + * @subpackage dml * @copyright 2008 Petr Skoda (http://skodak.org) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/lib/dml/moodle_temptables.php b/lib/dml/moodle_temptables.php index e28554cba1f..0ceefbf5124 100644 --- a/lib/dml/moodle_temptables.php +++ b/lib/dml/moodle_temptables.php @@ -37,6 +37,7 @@ * * @package core * @category dml + * @subpackage dml * @copyright 2009 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/lib/dml/moodle_transaction.php b/lib/dml/moodle_transaction.php index 78669a521b8..7709df23aaa 100644 --- a/lib/dml/moodle_transaction.php +++ b/lib/dml/moodle_transaction.php @@ -21,6 +21,7 @@ * * @package core * @category dml + * @subpackage dml * @copyright 2009 Petr Skoda (http://skodak.org) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ @@ -32,6 +33,7 @@ defined('MOODLE_INTERNAL') || die(); * * @package core * @category dml + * @subpackage dml * @copyright 2009 Petr Skoda (http://skodak.org) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/lib/dml/mssql_native_moodle_database.php b/lib/dml/mssql_native_moodle_database.php index 54d41bfbbbd..d1ee7333055 100644 --- a/lib/dml/mssql_native_moodle_database.php +++ b/lib/dml/mssql_native_moodle_database.php @@ -20,7 +20,7 @@ * Native mssql class representing moodle database interface. * * @package core - * @subpackage dml + * @subpackage dml_driver * @copyright 2009 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ @@ -33,6 +33,11 @@ require_once($CFG->libdir.'/dml/mssql_native_moodle_temptables.php'); /** * Native mssql class representing moodle database interface. + * + * @package core + * @subpackage dml_driver + * @copyright 2009 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com} + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class mssql_native_moodle_database extends moodle_database { diff --git a/lib/dml/mssql_native_moodle_recordset.php b/lib/dml/mssql_native_moodle_recordset.php index d5f3481a88f..d383d31860b 100644 --- a/lib/dml/mssql_native_moodle_recordset.php +++ b/lib/dml/mssql_native_moodle_recordset.php @@ -19,7 +19,7 @@ * MSSQL specific recordset. * * @package core - * @subpackage dml + * @subpackage dml_driver * @copyright 2009 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/lib/dml/mssql_native_moodle_temptables.php b/lib/dml/mssql_native_moodle_temptables.php index b598503f374..9242059978b 100644 --- a/lib/dml/mssql_native_moodle_temptables.php +++ b/lib/dml/mssql_native_moodle_temptables.php @@ -21,7 +21,7 @@ * temp table names included in the get_tables() method of the DB. * * @package core - * @subpackage dml + * @subpackage dml_driver * @copyright 2009 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/lib/dml/mysqli_native_moodle_database.php b/lib/dml/mysqli_native_moodle_database.php index f6f60430c61..da9609adb1d 100644 --- a/lib/dml/mysqli_native_moodle_database.php +++ b/lib/dml/mysqli_native_moodle_database.php @@ -20,7 +20,7 @@ * Native mysqli class representing moodle database interface. * * @package core - * @subpackage dml + * @subpackage dml_driver * @copyright 2008 Petr Skoda (http://skodak.org) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ @@ -33,6 +33,11 @@ require_once($CFG->libdir.'/dml/mysqli_native_moodle_temptables.php'); /** * Native mysqli class representing moodle database interface. + * + * @package core + * @subpackage dml_driver + * @copyright 2008 Petr Skoda (http://skodak.org) + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class mysqli_native_moodle_database extends moodle_database { diff --git a/lib/dml/mysqli_native_moodle_recordset.php b/lib/dml/mysqli_native_moodle_recordset.php index fae00433247..e8dc5bce994 100644 --- a/lib/dml/mysqli_native_moodle_recordset.php +++ b/lib/dml/mysqli_native_moodle_recordset.php @@ -20,7 +20,7 @@ * Mysqli specific recordset. * * @package core - * @subpackage dml + * @subpackage dml_driver * @copyright 2008 Petr Skoda (http://skodak.org) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ @@ -31,6 +31,11 @@ require_once($CFG->libdir.'/dml/moodle_recordset.php'); /** * Mysqli specific moodle recordset class + * + * @package core + * @subpackage dml_driver + * @copyright 2008 Petr Skoda (http://skodak.org) + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class mysqli_native_moodle_recordset extends moodle_recordset { diff --git a/lib/dml/mysqli_native_moodle_temptables.php b/lib/dml/mysqli_native_moodle_temptables.php index 595082ed806..0ad5132328f 100644 --- a/lib/dml/mysqli_native_moodle_temptables.php +++ b/lib/dml/mysqli_native_moodle_temptables.php @@ -21,7 +21,7 @@ * temp table names included in the get_tables() method of the DB. * * @package core - * @subpackage dml + * @subpackage dml_driver * @copyright 2009 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/lib/dml/oci_native_moodle_database.php b/lib/dml/oci_native_moodle_database.php index dd45a6f2a43..807abdf1f5e 100644 --- a/lib/dml/oci_native_moodle_database.php +++ b/lib/dml/oci_native_moodle_database.php @@ -20,7 +20,7 @@ * Native oci class representing moodle database interface. * * @package core - * @subpackage dml + * @subpackage dml_driver * @copyright 2008 Petr Skoda (http://skodak.org) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ @@ -36,19 +36,29 @@ require_once($CFG->libdir.'/dml/oci_native_moodle_temptables.php'); * * One complete reference for PHP + OCI: * http://www.oracle.com/technology/tech/php/underground-php-oracle-manual.html + * + * @package core + * @subpackage dml_driver + * @copyright 2008 Petr Skoda (http://skodak.org) + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class oci_native_moodle_database extends moodle_database { protected $oci = null; - private $last_stmt_error = null; // To store stmt errors and enable get_last_error() to detect them - private $commit_status = null; // default value initialised in connect method, we need the driver to be present + /** @var To store stmt errors and enable get_last_error() to detect them.*/ + private $last_stmt_error = null; + /** @var Default value initialised in connect method, we need the driver to be present.*/ + private $commit_status = null; - private $last_error_reporting; // To handle oci driver default verbosity - private $unique_session_id; // To store unique_session_id. Needed for temp tables unique naming - - private $dblocks_supported = null; // To cache locks support along the connection life - private $bitwise_supported = null; // To cache bitwise operations support along the connection life + /** @var To handle oci driver default verbosity.*/ + private $last_error_reporting; + /** @var To store unique_session_id. Needed for temp tables unique naming.*/ + private $unique_session_id; + /** @var To cache locks support along the connection life.*/ + private $dblocks_supported = null; + /** @var To cache bitwise operations support along the connection life.*/ + private $bitwise_supported = null; /** * Detects if all needed PHP stuff installed. diff --git a/lib/dml/oci_native_moodle_package.sql b/lib/dml/oci_native_moodle_package.sql index 84eddd56332..042c6106645 100644 --- a/lib/dml/oci_native_moodle_package.sql +++ b/lib/dml/oci_native_moodle_package.sql @@ -15,7 +15,7 @@ /** * @package core - * @subpackage dml + * @subpackage dml_driver * @copyright 2009 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @version 20091010 (plz, keep this updated for easier reference) diff --git a/lib/dml/oci_native_moodle_recordset.php b/lib/dml/oci_native_moodle_recordset.php index ed1112b49d8..4d8694a54b1 100644 --- a/lib/dml/oci_native_moodle_recordset.php +++ b/lib/dml/oci_native_moodle_recordset.php @@ -20,7 +20,7 @@ * Oracle specific recordset. * * @package core - * @subpackage dml + * @subpackage dml_driver * @copyright 2008 Petr Skoda (http://skodak.org) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/lib/dml/oci_native_moodle_temptables.php b/lib/dml/oci_native_moodle_temptables.php index 3c2a6571c83..1343d06dfe6 100644 --- a/lib/dml/oci_native_moodle_temptables.php +++ b/lib/dml/oci_native_moodle_temptables.php @@ -23,7 +23,7 @@ * method of the DB. * * @package core - * @subpackage dml + * @subpackage dml_driver * @copyright 2009 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/lib/dml/pdo_moodle_database.php b/lib/dml/pdo_moodle_database.php index b3318a5e988..ef2da313cb3 100644 --- a/lib/dml/pdo_moodle_database.php +++ b/lib/dml/pdo_moodle_database.php @@ -20,7 +20,7 @@ * Experimental pdo database class * * @package core - * @subpackage dml + * @subpackage dml_driver * @copyright 2008 Andrei Bautu * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ @@ -32,6 +32,11 @@ require_once($CFG->libdir.'/dml/pdo_moodle_recordset.php'); /** * Experimental pdo database class + * + * @package core + * @subpackage dml_driver + * @copyright 2008 Andrei Bautu + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class pdo_moodle_database extends moodle_database { diff --git a/lib/dml/pdo_moodle_recordset.php b/lib/dml/pdo_moodle_recordset.php index 64be1bd1b19..803416f590c 100644 --- a/lib/dml/pdo_moodle_recordset.php +++ b/lib/dml/pdo_moodle_recordset.php @@ -20,7 +20,7 @@ * Experimental pdo recordset * * @package core - * @subpackage dml + * @subpackage dml_driver * @copyright 2008 Andrei Bautu * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ @@ -31,6 +31,11 @@ require_once($CFG->libdir.'/dml/moodle_recordset.php'); /** * Experimental pdo recordset + * + * @package core + * @subpackage dml_driver + * @copyright 2008 Andrei Bautu + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class pdo_moodle_recordset extends moodle_recordset { diff --git a/lib/dml/pgsql_native_moodle_database.php b/lib/dml/pgsql_native_moodle_database.php index 4bdc50233e0..9e7df66858c 100644 --- a/lib/dml/pgsql_native_moodle_database.php +++ b/lib/dml/pgsql_native_moodle_database.php @@ -20,7 +20,7 @@ * Native pgsql class representing moodle database interface. * * @package core - * @subpackage dml + * @subpackage dml_driver * @copyright 2008 Petr Skoda (http://skodak.org) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ @@ -33,6 +33,11 @@ require_once($CFG->libdir.'/dml/pgsql_native_moodle_temptables.php'); /** * Native pgsql class representing moodle database interface. + * + * @package core + * @subpackage dml_driver + * @copyright 2008 Petr Skoda (http://skodak.org) + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class pgsql_native_moodle_database extends moodle_database { diff --git a/lib/dml/pgsql_native_moodle_recordset.php b/lib/dml/pgsql_native_moodle_recordset.php index 70d655e132f..6d00d157f56 100644 --- a/lib/dml/pgsql_native_moodle_recordset.php +++ b/lib/dml/pgsql_native_moodle_recordset.php @@ -20,7 +20,7 @@ * Native postgresql recordset. * * @package core - * @subpackage dml + * @subpackage dml_driver * @copyright 2008 Petr Skoda (http://skodak.org) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ @@ -31,11 +31,17 @@ require_once($CFG->libdir.'/dml/moodle_recordset.php'); /** * pgsql specific moodle recordset class + * + * @package core + * @subpackage dml_driver + * @copyright 2008 Petr Skoda (http://skodak.org) + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class pgsql_native_moodle_recordset extends moodle_recordset { protected $result; - protected $current; // current row as array + /** @var current row as array.*/ + protected $current; protected $bytea_oid; protected $blobs = array(); diff --git a/lib/dml/pgsql_native_moodle_temptables.php b/lib/dml/pgsql_native_moodle_temptables.php index c58bf4baced..4227da15cf9 100644 --- a/lib/dml/pgsql_native_moodle_temptables.php +++ b/lib/dml/pgsql_native_moodle_temptables.php @@ -21,7 +21,7 @@ * temp table names included in the get_tables() method of the DB. * * @package core - * @subpackage dml + * @subpackage dml_driver * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/lib/dml/sqlite3_pdo_moodle_database.php b/lib/dml/sqlite3_pdo_moodle_database.php index 1ab7eb00b4c..b28334c87cc 100644 --- a/lib/dml/sqlite3_pdo_moodle_database.php +++ b/lib/dml/sqlite3_pdo_moodle_database.php @@ -20,7 +20,7 @@ * Experimental pdo database class. * * @package core - * @subpackage dml + * @subpackage dml_driver * @copyright 2008 Andrei Bautu * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ @@ -31,6 +31,11 @@ require_once($CFG->libdir.'/dml/pdo_moodle_database.php'); /** * Experimental pdo database class + * + * @package core + * @subpackage dml_driver + * @copyright 2008 Andrei Bautu + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class sqlite3_pdo_moodle_database extends pdo_moodle_database { protected $database_file_extension = '.sq3.php'; diff --git a/lib/dml/sqlsrv_native_moodle_database.php b/lib/dml/sqlsrv_native_moodle_database.php index 6218634b93c..757e6456c9b 100644 --- a/lib/dml/sqlsrv_native_moodle_database.php +++ b/lib/dml/sqlsrv_native_moodle_database.php @@ -19,7 +19,7 @@ * Native sqlsrv class representing moodle database interface. * * @package core - * @subpackage dml + * @subpackage dml_driver * @copyright 2009 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v2 or later */ @@ -32,6 +32,11 @@ require_once($CFG->libdir.'/dml/sqlsrv_native_moodle_temptables.php'); /** * Native sqlsrv class representing moodle database interface. + * + * @package core + * @subpackage dml_driver + * @copyright 2009 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com} + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v2 or later */ class sqlsrv_native_moodle_database extends moodle_database { diff --git a/lib/dml/sqlsrv_native_moodle_recordset.php b/lib/dml/sqlsrv_native_moodle_recordset.php index 8ee18fdbf39..1f9965506cb 100644 --- a/lib/dml/sqlsrv_native_moodle_recordset.php +++ b/lib/dml/sqlsrv_native_moodle_recordset.php @@ -16,10 +16,10 @@ // along with Moodle. If not, see . /** - * sqlsrv specific recorset. + * sqlsrv specific recordset. * * @package core - * @subpackage dml + * @subpackage dml_driver * @copyright 2009 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v2 or later */ diff --git a/lib/dml/sqlsrv_native_moodle_temptables.php b/lib/dml/sqlsrv_native_moodle_temptables.php index 461976903ce..fe860346586 100644 --- a/lib/dml/sqlsrv_native_moodle_temptables.php +++ b/lib/dml/sqlsrv_native_moodle_temptables.php @@ -21,7 +21,7 @@ * temp table names included in the get_tables() method of the DB. * * @package core - * @subpackage dml + * @subpackage dml_driver * @copyright 2009 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v2 or later */ @@ -31,7 +31,12 @@ defined('MOODLE_INTERNAL') || die(); require_once($CFG->libdir.'/dml/mssql_native_moodle_temptables.php'); /*** -* This class is not specific to the SQL Server Native Driver but rather -* to the family of Microsoft SQL Servers -*/ + * This class is not specific to the SQL Server Native Driver but rather + * to the family of Microsoft SQL Servers. + * + * @package core + * @subpackage dml_driver + * @copyright 2009 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com} + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v2 or later + */ class sqlsrv_native_moodle_temptables extends mssql_native_moodle_temptables {}