Permalink
Browse files

MDL-30972 Documentation : Renamed DB engine drivers to "@package core…

…" but moodle_*.php are "@subpackage dml_driver", all other dml/*.php are "@subpackage dml".
  • Loading branch information...
nebgor committed Jan 20, 2012
1 parent ae1e17c commit a0eb2e97f9054c623541978e746dfacb22eb9f10
@@ -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 @@
* '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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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 @@
*
* @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
*/
@@ -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 @@
/**
* 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 {
@@ -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
*/
@@ -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
*/
@@ -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 @@
/**
* 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 {
@@ -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 @@
/**
* 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 {
@@ -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
*/
@@ -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 @@
*
* 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
-
- 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 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;
+
+ /** @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.
@@ -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)
@@ -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
*/
@@ -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
*/
@@ -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 @@
/**
* 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 {
@@ -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 @@
/**
* 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 {
@@ -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 @@
/**
* 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 {
@@ -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 @@
/**
* 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();
@@ -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
*/
@@ -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 @@
/**
* 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';
@@ -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 @@
/**
* 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 {
@@ -16,10 +16,10 @@
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
- * 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
*/
Oops, something went wrong.

0 comments on commit a0eb2e9

Please sign in to comment.