Code cleanups and comments

[Project_webapp.git] / lib / db.php

diff --git a/lib/db.php b/lib/db.php
index cd9b0825331a60c40b9c9a6d23590c487ffa8cd6..9d967d6dd4bbec29ff9d54b1acd9cf6aa33cc9cb 100644 (file)
--- a/lib/db.php
+++ b/lib/db.php
@@ -12,11 +12,13 @@ class CustomDB
     private $current_result;
 
     /**
-     * [__construct description]
-     * @param [type] $host     [description]
-     * @param [type] $username [description]
-     * @param [type] $password [description]
-     * @param [type] $dbname   [description]
+     * __construct class constructor method that permit to initialize
+     * the connection to the RDBMS database
+     * @param string $host     RDBMS hostname
+     * @param string $username RDBMS user
+     * @param string $password RDBMS user password
+     * @param string $dbname   RDBMS database to use
+     * @return object an object which represents the connection to a RDBMS Server.
      */
     public function __construct($host, $username, $password, $dbname)
     {
@@ -31,14 +33,17 @@ class CustomDB
         return $this->connection;
     }
 
+    /**
+     * [__destruct description]
+     */
     /* public function __destruct()
     {
         $this->close();
     } */
 
     /**
-     * [close description]
-     * @return [type] [description]
+     * close method to close the opened connection to the RDBMS server
+     * @return void
      */
     public function close()
     {
@@ -50,9 +55,10 @@ class CustomDB
     }
 
     /**
-     * [query description]
-     * @param  [type] $sql_query [description]
-     * @return [type]            [description]
+     * query method that permit to execute a SQL query
+     * @param  string $sql_query the SQL query to execute
+     * @return object mysqli_result or FALSE on failure and TRUE for queries
+     * without results
      */
     public function query($sql_query)
     {
@@ -63,9 +69,9 @@ class CustomDB
     }
 
     /**
-     * [prepare_query description]
-     * @param  [type] $prepared_query [description]
-     * @return [type]                 [description]
+     * prepare_query method for parametrized SQL query preparation
+     * @param  string $prepared_query parametrized SQL query to prepare
+     * @return object statement object or FALSE if an error occurred
      */
     public function prepare_query($prepared_query)
     {
@@ -79,10 +85,10 @@ class CustomDB
     }
 
     /**
-     * [prepared_query_bind_param description]
-     * @param  [type] $types  [description]
-     * @param  [type] $params [description]
-     * @return [type]         [description]
+     * prepared_query_bind_param link parameters values to a prepared SQL query
+     * @param  string $types  parameters types
+     * @param  array $params unidimensional array of parameters values
+     * @return boolean TRUE on success or FALSE on failure
      */
     public function prepared_query_bind_param($types, $params)
     {
@@ -94,8 +100,9 @@ class CustomDB
     }
 
     /**
-     * [run_prepared_query description]
-     * @return [type] [description]
+     * run_prepared_query method that execute a parametrized SQL query linked
+     * with its parameters values
+     * @return boolean TRUE on success or FALSE on failure
      */
     public function run_prepared_query()
     {
@@ -106,6 +113,10 @@ class CustomDB
         return $rt_val;
     }
 
+    /**
+     * get_pquery_result method to get the resultset of parametrized SQL query
+     * @return object mysqli_result resultset or FALSE for other DML queries or on failure
+     */
     public function get_pquery_result()
     {
         $rt_val = $this->current_result = $this->current_stmt->get_result();
@@ -115,6 +126,10 @@ class CustomDB
         return $rt_val;
     }
 
+    /**
+     * [get_result_array description]
+     * @return [type] [description]
+     */
     public function get_result_array()
     {
         $row = $this->current_result->fetch_array();