MDL-21249 improved php docs and adding direct access prevention in dml

Mrmoodle · Jul 25, 2010 · f2ed3f0 · f2ed3f0
1 parent c86f538
commit f2ed3f0
Show file tree

Hide file tree

Showing 23 changed files with 122 additions and 77 deletions.
diff --git a/lib/dml/database_column_info.php b/lib/dml/database_column_info.php
@@ -19,12 +19,14 @@
 /**
  * Database column information.
  *
- * @package    moodlecore
- * @subpackage DML
+ * @package    code
+ * @subpackage dml
  * @copyright  2008 Petr Skoda (http://skodak.org)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Detail database field information.
  * Based on ADOFieldObject.

diff --git a/lib/dml/moodle_database.php b/lib/dml/moodle_database.php
@@ -19,12 +19,14 @@
 /**
  * Abstract database driver class.
  *
- * @package    moodlecore
- * @subpackage DML
+ * @package    code
+ * @subpackage dml
  * @copyright  2008 Petr Skoda (http://skodak.org)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 require_once($CFG->libdir.'/dml/database_column_info.php');
 require_once($CFG->libdir.'/dml/moodle_recordset.php');
 require_once($CFG->libdir.'/dml/moodle_transaction.php');

diff --git a/lib/dml/moodle_recordset.php b/lib/dml/moodle_recordset.php
@@ -19,12 +19,14 @@
 /**
  * Abstract recordset.
  *
- * @package    moodlecore
- * @subpackage DML
+ * @package    code
+ * @subpackage dml
  * @copyright  2008 Petr Skoda (http://skodak.org)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Abstract class for resultsets returned from database functions.
  * This is a simple Iterator with needed recorset closing support.

diff --git a/lib/dml/moodle_temptables.php b/lib/dml/moodle_temptables.php
@@ -33,15 +33,16 @@
  * of doing temporary tables support 100% cross-db and transparent within the DB API.
  *
  * Only drivers needing it will use this store. Neither moodle_database (abstract) or
- * databases like postgres need this, because they don't lack any temp functionality.º:w
-
+ * databases like postgres need this, because they don't lack any temp functionality.
  *
- * @package    moodlecore
- * @subpackage DML
+ * @package    code
+ * @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
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 class moodle_temptables {
 
     protected $mdb;        // circular reference, to be able to use DB facilities here if needed

diff --git a/lib/dml/moodle_transaction.php b/lib/dml/moodle_transaction.php
@@ -19,12 +19,14 @@
 /**
  * Delegated database transaction support.
  *
- * @package    moodlecore
- * @subpackage DML
+ * @package    code
+ * @subpackage dml
  * @copyright  2009 Petr Skoda (http://skodak.org)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Delegated transaction class.
  */

diff --git a/lib/dml/mssql_native_moodle_database.php b/lib/dml/mssql_native_moodle_database.php
@@ -19,12 +19,14 @@
 /**
  * Native mssql class representing moodle database interface.
  *
- * @package    moodlecore
- * @subpackage DML
+ * @package    code
+ * @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
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 require_once($CFG->libdir.'/dml/moodle_database.php');
 require_once($CFG->libdir.'/dml/mssql_native_moodle_recordset.php');
 require_once($CFG->libdir.'/dml/mssql_native_moodle_temptables.php');

diff --git a/lib/dml/mssql_native_moodle_recordset.php b/lib/dml/mssql_native_moodle_recordset.php
@@ -18,12 +18,14 @@
 /**
  * MSSQL specific recordset.
  *
- * @package    moodlecore
- * @subpackage DML
+ * @package    code
+ * @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
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 require_once($CFG->libdir.'/dml/moodle_recordset.php');
 
 class mssql_native_moodle_recordset extends moodle_recordset {

diff --git a/lib/dml/mssql_native_moodle_temptables.php b/lib/dml/mssql_native_moodle_temptables.php
@@ -20,12 +20,14 @@
  * are named differently than normal tables. Also used to be able to retrieve
  * temp table names included in the get_tables() method of the DB.
  *
- * @package    moodlecore
- * @subpackage DML
+ * @package    code
+ * @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
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 require_once($CFG->libdir.'/dml/moodle_temptables.php');
 
 class mssql_native_moodle_temptables extends moodle_temptables {

diff --git a/lib/dml/mysqli_native_moodle_database.php b/lib/dml/mysqli_native_moodle_database.php
@@ -19,12 +19,14 @@
 /**
  * Native mysqli class representing moodle database interface.
  *
- * @package    moodlecore
- * @subpackage DML
+ * @package    code
+ * @subpackage dml
  * @copyright  2008 Petr Skoda (http://skodak.org)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 require_once($CFG->libdir.'/dml/moodle_database.php');
 require_once($CFG->libdir.'/dml/mysqli_native_moodle_recordset.php');
 require_once($CFG->libdir.'/dml/mysqli_native_moodle_temptables.php');

diff --git a/lib/dml/mysqli_native_moodle_recordset.php b/lib/dml/mysqli_native_moodle_recordset.php
@@ -19,12 +19,14 @@
 /**
  * Mysqli specific recordset.
  *
- * @package    moodlecore
- * @subpackage DML
+ * @package    code
+ * @subpackage dml
  * @copyright  2008 Petr Skoda (http://skodak.org)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 require_once($CFG->libdir.'/dml/moodle_recordset.php');
 
 /**

diff --git a/lib/dml/mysqli_native_moodle_temptables.php b/lib/dml/mysqli_native_moodle_temptables.php
@@ -20,12 +20,14 @@
  * are named differently than normal tables. Also used to be able to retrieve
  * temp table names included in the get_tables() method of the DB.
  *
- * @package    moodlecore
- * @subpackage DML
+ * @package    code
+ * @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
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 require_once($CFG->libdir.'/dml/moodle_temptables.php');
 
 class mysqli_native_moodle_temptables extends moodle_temptables {

diff --git a/lib/dml/oci_native_moodle_database.php b/lib/dml/oci_native_moodle_database.php
@@ -19,12 +19,14 @@
 /**
  * Native oci class representing moodle database interface.
  *
- * @package    moodlecore
- * @subpackage DML
+ * @package    code
+ * @subpackage dml
  * @copyright  2008 Petr Skoda (http://skodak.org)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 require_once($CFG->libdir.'/dml/moodle_database.php');
 require_once($CFG->libdir.'/dml/oci_native_moodle_recordset.php');
 require_once($CFG->libdir.'/dml/oci_native_moodle_temptables.php');

diff --git a/lib/dml/oci_native_moodle_recordset.php b/lib/dml/oci_native_moodle_recordset.php
@@ -19,12 +19,14 @@
 /**
  * Oracle specific recordset.
  *
- * @package    moodlecore
- * @subpackage DML
+ * @package    code
+ * @subpackage dml
  * @copyright  2008 Petr Skoda (http://skodak.org)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 require_once($CFG->libdir.'/dml/moodle_recordset.php');
 
 class oci_native_moodle_recordset extends moodle_recordset {

diff --git a/lib/dml/oci_native_moodle_temptables.php b/lib/dml/oci_native_moodle_temptables.php
@@ -22,12 +22,14 @@
  * Also used to be able to retrieve temp table names included in the get_tables()
  * method of the DB.
  *
- * @package    moodlecore
- * @subpackage DML
+ * @package    code
+ * @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
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 require_once($CFG->libdir.'/dml/moodle_temptables.php');
 
 class oci_native_moodle_temptables extends moodle_temptables {

diff --git a/lib/dml/pdo_moodle_database.php b/lib/dml/pdo_moodle_database.php
@@ -19,12 +19,14 @@
 /**
  * Experimental pdo database class
  *
- * @package    moodlecore
- * @subpackage DML
+ * @package    code
+ * @subpackage dml
  * @copyright  2008 Andrei Bautu
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 require_once($CFG->libdir.'/dml/moodle_database.php');
 require_once($CFG->libdir.'/dml/pdo_moodle_recordset.php');
 

diff --git a/lib/dml/pdo_moodle_recordset.php b/lib/dml/pdo_moodle_recordset.php
@@ -19,12 +19,14 @@
 /**
  * Experimental pdo recordset
  *
- * @package    moodlecore
- * @subpackage DML
+ * @package    code
+ * @subpackage dml
  * @copyright  2008 Andrei Bautu
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 require_once($CFG->libdir.'/dml/moodle_recordset.php');
 
 /**

diff --git a/lib/dml/pgsql_native_moodle_database.php b/lib/dml/pgsql_native_moodle_database.php
@@ -19,12 +19,14 @@
 /**
  * Native pgsql class representing moodle database interface.
  *
- * @package    moodlecore
- * @subpackage DML
+ * @package    code
+ * @subpackage dml
  * @copyright  2008 Petr Skoda (http://skodak.org)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 require_once($CFG->libdir.'/dml/moodle_database.php');
 require_once($CFG->libdir.'/dml/pgsql_native_moodle_recordset.php');
 require_once($CFG->libdir.'/dml/pgsql_native_moodle_temptables.php');

diff --git a/lib/dml/pgsql_native_moodle_recordset.php b/lib/dml/pgsql_native_moodle_recordset.php
@@ -19,12 +19,14 @@
 /**
  * Native postgresql recordset.
  *
- * @package    moodlecore
- * @subpackage DML
+ * @package    code
+ * @subpackage dml
  * @copyright  2008 Petr Skoda (http://skodak.org)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 require_once($CFG->libdir.'/dml/moodle_recordset.php');
 
 /**

diff --git a/lib/dml/pgsql_native_moodle_temptables.php b/lib/dml/pgsql_native_moodle_temptables.php
@@ -20,12 +20,14 @@
  * are named differently than normal tables. Also used to be able to retrieve
  * temp table names included in the get_tables() method of the DB.
  *
- * @package    moodlecore
- * @subpackage DML
+ * @package    code
+ * @subpackage dml
  * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 require_once($CFG->libdir.'/dml/moodle_temptables.php');
 
 class pgsql_native_moodle_temptables extends moodle_temptables {

diff --git a/lib/dml/sqlite3_pdo_moodle_database.php b/lib/dml/sqlite3_pdo_moodle_database.php
@@ -19,12 +19,14 @@
 /**
  * Experimental pdo database class.
  *
- * @package    moodlecore
- * @subpackage DML
+ * @package    code
+ * @subpackage dml
  * @copyright  2008 Andrei Bautu
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 require_once($CFG->libdir.'/dml/pdo_moodle_database.php');
 
 /**