MDL-14679 more return types added
authorPetr Skoda <skodak@moodle.org>
Sun, 22 Aug 2010 19:06:06 +0000 (19:06 +0000)
committerPetr Skoda <skodak@moodle.org>
Sun, 22 Aug 2010 19:06:06 +0000 (19:06 +0000)
lib/dml/moodle_database.php
lib/dml/mssql_native_moodle_database.php
lib/dml/mysqli_native_moodle_database.php
lib/dml/oci_native_moodle_database.php
lib/dml/pdo_moodle_database.php
lib/dml/pgsql_native_moodle_database.php
lib/dml/sqlsrv_native_moodle_database.php

index 1e2643b..675ebca 100644 (file)
@@ -296,6 +296,7 @@ abstract class moodle_database {
      * Close database connection and release all resources
      * and memory (especially circular memory references).
      * Do NOT use connect() again, create a new instance if needed.
+     * @return void
      */
     public function dispose() {
         if ($this->transactions) {
@@ -446,12 +447,13 @@ abstract class moodle_database {
 
     /**
      * Returns supported query parameter types
-     * @return bitmask
+     * @return int bitmask
      */
     protected abstract function allowed_param_types();
 
     /**
      * Returns last error reported by database engine.
+     * @return string error message
      */
     public abstract function get_last_error();
 
index cfbefd9..a8d6cbd 100644 (file)
@@ -303,7 +303,7 @@ class mssql_native_moodle_database extends moodle_database {
 
     /**
      * Returns supported query parameter types
-     * @return bitmask
+     * @return int bitmask
      */
     protected function allowed_param_types() {
         return SQL_PARAMS_QM; // Not really, but emulated, see emulate_bound_params()
@@ -311,6 +311,7 @@ class mssql_native_moodle_database extends moodle_database {
 
     /**
      * Returns last error reported by database engine.
+     * @return string error message
      */
     public function get_last_error() {
         return mssql_get_last_message();
index d656abd..94b2d25 100644 (file)
@@ -317,7 +317,7 @@ class mysqli_native_moodle_database extends moodle_database {
 
     /**
      * Returns supported query parameter types
-     * @return bitmask
+     * @return int bitmask
      */
     protected function allowed_param_types() {
         return SQL_PARAMS_QM;
@@ -325,6 +325,7 @@ class mysqli_native_moodle_database extends moodle_database {
 
     /**
      * Returns last error reported by database engine.
+     * @return string error message
      */
     public function get_last_error() {
         return $this->mysqli->error;
index 5fcdacf..d95bba5 100644 (file)
@@ -301,7 +301,7 @@ class oci_native_moodle_database extends moodle_database {
 
     /**
      * Returns supported query parameter types
-     * @return bitmask
+     * @return int bitmask
      */
     protected function allowed_param_types() {
         return SQL_PARAMS_NAMED;
@@ -309,6 +309,7 @@ class oci_native_moodle_database extends moodle_database {
 
     /**
      * Returns last error reported by database engine.
+     * @return string error message
      */
     public function get_last_error() {
         $error = false;
index 3f05262..9af6193 100644 (file)
@@ -153,7 +153,7 @@ abstract class pdo_moodle_database extends moodle_database {
 
     /**
      * Returns supported query parameter types
-     * @return bitmask
+     * @return int bitmask
      */
     protected function allowed_param_types() {
         return SQL_PARAMS_QM | SQL_PARAMS_NAMED;
@@ -161,6 +161,7 @@ abstract class pdo_moodle_database extends moodle_database {
 
     /**
      * Returns last error reported by database engine.
+     * @return string error message
      */
     public function get_last_error() {
         return $this->lastError;
index 27963ac..0ee68de 100644 (file)
@@ -251,7 +251,7 @@ class pgsql_native_moodle_database extends moodle_database {
 
     /**
      * Returns supported query parameter types
-     * @return bitmask
+     * @return int bitmask
      */
     protected function allowed_param_types() {
         return SQL_PARAMS_DOLLAR;
@@ -259,6 +259,7 @@ class pgsql_native_moodle_database extends moodle_database {
 
     /**
      * Returns last error reported by database engine.
+     * @return string error message
      */
     public function get_last_error() {
         return pg_last_error($this->pgsql);
index dbf104e..b8c62ac 100644 (file)
@@ -306,7 +306,7 @@ class sqlsrv_native_moodle_database extends moodle_database {
 
     /**
      * Returns supported query parameter types
-     * @return bitmask
+     * @return int bitmask
      */
     protected function allowed_param_types() {
         return SQL_PARAMS_QM;  // sqlsrv 1.1 can bind
@@ -314,6 +314,7 @@ class sqlsrv_native_moodle_database extends moodle_database {
 
     /**
      * Returns last error reported by database engine.
+     * @return string error message
      */
     public function get_last_error() {
         $retErrors = sqlsrv_errors(SQLSRV_ERR_ALL);