summaryrefslogtreecommitdiffstats
path: root/system/database
diff options
context:
space:
mode:
authorAndrey Andreev <narf@bofh.bg>2012-10-24 13:55:35 +0200
committerAndrey Andreev <narf@bofh.bg>2012-10-24 13:55:35 +0200
commit5fd3ae8d33a4f5d3159b86683b9a670e973a63f5 (patch)
treee9d9b67931545e1059b2e27d532ac81ec5f33133 /system/database
parent3639d4798cd1ac26b715d8d74ff7855474fb01d7 (diff)
[ci skip] style and phpdoc-related changes (rel #1295)
Diffstat (limited to 'system/database')
-rw-r--r--system/database/DB_cache.php15
-rw-r--r--system/database/DB_driver.php15
-rw-r--r--system/database/DB_forge.php15
-rw-r--r--system/database/DB_query_builder.php68
-rw-r--r--system/database/DB_result.php26
-rw-r--r--system/database/DB_utility.php6
-rw-r--r--system/database/drivers/cubrid/cubrid_driver.php7
-rw-r--r--system/database/drivers/cubrid/cubrid_result.php1
-rw-r--r--system/database/drivers/ibase/ibase_driver.php1
-rw-r--r--system/database/drivers/mssql/mssql_driver.php5
-rw-r--r--system/database/drivers/mssql/mssql_result.php1
-rw-r--r--system/database/drivers/mysql/mysql_driver.php1
-rw-r--r--system/database/drivers/mysql/mysql_result.php1
-rw-r--r--system/database/drivers/mysqli/mysqli_driver.php1
-rw-r--r--system/database/drivers/mysqli/mysqli_result.php1
-rw-r--r--system/database/drivers/oci8/oci8_driver.php6
-rw-r--r--system/database/drivers/odbc/odbc_driver.php9
-rw-r--r--system/database/drivers/pdo/pdo_driver.php3
-rw-r--r--system/database/drivers/postgre/postgre_driver.php1
-rw-r--r--system/database/drivers/postgre/postgre_forge.php14
-rw-r--r--system/database/drivers/postgre/postgre_result.php1
-rw-r--r--system/database/drivers/sqlite/sqlite_driver.php1
-rw-r--r--system/database/drivers/sqlite/sqlite_result.php1
-rw-r--r--system/database/drivers/sqlite3/sqlite3_driver.php6
-rw-r--r--system/database/drivers/sqlite3/sqlite3_result.php1
-rw-r--r--system/database/drivers/sqlsrv/sqlsrv_driver.php2
26 files changed, 147 insertions, 62 deletions
diff --git a/system/database/DB_cache.php b/system/database/DB_cache.php
index bdd91867a..671147b3d 100644
--- a/system/database/DB_cache.php
+++ b/system/database/DB_cache.php
@@ -37,6 +37,12 @@ class CI_DB_Cache {
public $CI;
public $db; // allows passing of db object so that multiple database connections and returned db objects can be supported
+ /**
+ * Constructor
+ *
+ * @param &$db
+ * @return void
+ */
public function __construct(&$db)
{
// Assign the main CI object to $this->CI and load the file helper since we use it a lot
@@ -90,6 +96,7 @@ class CI_DB_Cache {
* The URI being requested will become the name of the cache sub-folder.
* An MD5 hash of the SQL statement will become the cache file name
*
+ * @param string $sql
* @return string
*/
public function read($sql)
@@ -111,6 +118,8 @@ class CI_DB_Cache {
/**
* Write a query to a cache file
*
+ * @param string $sql
+ * @param object $object
* @return bool
*/
public function write($sql, $object)
@@ -144,7 +153,9 @@ class CI_DB_Cache {
/**
* Delete cache files within a particular directory
*
- * @return bool
+ * @param string $segment_one = ''
+ * @param string $segment_two = ''
+ * @return void
*/
public function delete($segment_one = '', $segment_two = '')
{
@@ -167,7 +178,7 @@ class CI_DB_Cache {
/**
* Delete all existing cache files
*
- * @return bool
+ * @return void
*/
public function delete_all()
{
diff --git a/system/database/DB_driver.php b/system/database/DB_driver.php
index b7b19d207..7f1434fc1 100644
--- a/system/database/DB_driver.php
+++ b/system/database/DB_driver.php
@@ -310,8 +310,9 @@ abstract class CI_DB_driver {
* FALSE upon failure, and if the $db_debug variable is set to TRUE
* will raise an error.
*
- * @param string An SQL query string
- * @param array An array of binding data
+ * @param string $sql
+ * @param array $binds = FALSE An array of binding data
+ * @param bool $return_object = NULL
* @return mixed
*/
public function query($sql, $binds = FALSE, $return_object = NULL)
@@ -514,6 +515,7 @@ abstract class CI_DB_driver {
* If strict mode is disabled, each group is treated autonomously, meaning
* a failure of one group will not affect any others
*
+ * @param bool $mode = TRUE
* @return void
*/
public function trans_strict($mode = TRUE)
@@ -526,6 +528,7 @@ abstract class CI_DB_driver {
/**
* Start Transaction
*
+ * @param bool $test_mode = FALSE
* @return void
*/
public function trans_start($test_mode = FALSE)
@@ -810,6 +813,7 @@ abstract class CI_DB_driver {
/**
* Returns an array of table names
*
+ * @param string $constrain_by_prefix = FALSE
* @return array
*/
public function list_tables($constrain_by_prefix = FALSE)
@@ -864,6 +868,7 @@ abstract class CI_DB_driver {
/**
* Determine if a particular table exists
*
+ * @param string $table_name
* @return bool
*/
public function table_exists($table_name)
@@ -1193,8 +1198,8 @@ abstract class CI_DB_driver {
/**
* Enables a native PHP function to be run, using a platform agnostic wrapper.
*
- * @param string the function name
- * @param mixed any parameters needed by the function
+ * @param string $function the function name
+ * @param mixed $param,... optional parameters needed by the function
* @return mixed
*/
public function call_function($function)
@@ -1258,6 +1263,8 @@ abstract class CI_DB_driver {
/**
* Delete the cache files associated with a particular URI
*
+ * @param string $segment_one = ''
+ * @param string $segment_two = ''
* @return bool
*/
public function cache_delete($segment_one = '', $segment_two = '')
diff --git a/system/database/DB_forge.php b/system/database/DB_forge.php
index 91f9d560c..119d78d38 100644
--- a/system/database/DB_forge.php
+++ b/system/database/DB_forge.php
@@ -37,7 +37,7 @@ abstract class CI_DB_forge {
public $fields = array();
public $keys = array();
public $primary_keys = array();
- public $db_char_set = '';
+ public $db_char_set = '';
// Platform specific SQL strings
protected $_create_database = 'CREATE DATABASE %s';
@@ -45,6 +45,11 @@ abstract class CI_DB_forge {
protected $_drop_table = 'DROP TABLE IF EXISTS %s';
protected $_rename_table = 'ALTER TABLE %s RENAME TO %s';
+ /**
+ * Constructor
+ *
+ * @return void
+ */
public function __construct()
{
// Assign the main database object to $this->db
@@ -206,7 +211,8 @@ abstract class CI_DB_forge {
/**
* Create Table
*
- * @param string the table name
+ * @param string $table = ''
+ * @param bool $if_not_exists = FALSE
* @return bool
*/
public function create_table($table = '', $if_not_exists = FALSE)
@@ -378,9 +384,8 @@ abstract class CI_DB_forge {
/**
* Column Modify
*
- * @param string the table name
- * @param string the column name
- * @param string the column definition
+ * @param string $table = ''
+ * @param string $field = array() column definition
* @return bool
*/
public function modify_column($table = '', $field = array())
diff --git a/system/database/DB_query_builder.php b/system/database/DB_query_builder.php
index a6e6e595f..5fc3d1866 100644
--- a/system/database/DB_query_builder.php
+++ b/system/database/DB_query_builder.php
@@ -182,15 +182,17 @@ abstract class CI_DB_query_builder extends CI_DB_driver {
// --------------------------------------------------------------------
/**
- * Processing Function for the four functions above:
+ * Processing Function for the following functions:
*
* select_max()
* select_min()
* select_avg()
* select_sum()
*
- * @param string the field
- * @param string an alias
+ *
+ * @param string $select = '' field name
+ * @param string $alias = ''
+ * @param string $type = 'MAX'
* @return object
*/
protected function _max_min_avg_sum($select = '', $alias = '', $type = 'MAX')
@@ -504,11 +506,12 @@ abstract class CI_DB_query_builder extends CI_DB_driver {
/**
* Where_in
*
- * Generates a WHERE field IN ('item', 'item') SQL query joined with
+ * Generates a WHERE field IN('item', 'item') SQL query joined with
* AND if appropriate
*
- * @param string The field to search
- * @param array The values searched on
+ * @param string $key = NULL The field to search
+ * @param array $values = NULL The values searched on
+ * @param bool $escape = NULL
* @return object
*/
public function where_in($key = NULL, $values = NULL, $escape = NULL)
@@ -519,13 +522,14 @@ abstract class CI_DB_query_builder extends CI_DB_driver {
// --------------------------------------------------------------------
/**
- * Where_in_or
+ * Or_where_in
*
- * Generates a WHERE field IN ('item', 'item') SQL query joined with
+ * Generates a WHERE field IN('item', 'item') SQL query joined with
* OR if appropriate
*
- * @param string The field to search
- * @param array The values searched on
+ * @param string $key = NULL The field to search
+ * @param array $values = NULL The values searched on
+ * @param bool $escape = NULL
* @return object
*/
public function or_where_in($key = NULL, $values = NULL, $escape = NULL)
@@ -538,11 +542,12 @@ abstract class CI_DB_query_builder extends CI_DB_driver {
/**
* Where_not_in
*
- * Generates a WHERE field NOT IN ('item', 'item') SQL query joined
+ * Generates a WHERE field NOT IN('item', 'item') SQL query joined
* with AND if appropriate
*
- * @param string The field to search
- * @param array The values searched on
+ * @param string $key = NULL The field to search
+ * @param array $values = NULL The values searched on
+ * @param bool $escape = NULL
* @return object
*/
public function where_not_in($key = NULL, $values = NULL, $escape = NULL)
@@ -553,13 +558,14 @@ abstract class CI_DB_query_builder extends CI_DB_driver {
// --------------------------------------------------------------------
/**
- * Where_not_in_or
+ * Or_where_not_in
*
- * Generates a WHERE field NOT IN ('item', 'item') SQL query joined
+ * Generates a WHERE field NOT IN('item', 'item') SQL query joined
* with OR if appropriate
*
- * @param string The field to search
- * @param array The values searched on
+ * @param string $key = NULL The field to search
+ * @param array $values = NULL The values searched on
+ * @param bool $escape = NULL
* @return object
*/
public function or_where_not_in($key = NULL, $values = NULL, $escape = NULL)
@@ -572,12 +578,13 @@ abstract class CI_DB_query_builder extends CI_DB_driver {
/**
* Where_in
*
- * Called by where_in, where_in_or, where_not_in, where_not_in_or
+ * Called by where_in(), or_where_in(), where_not_in(), or_where_not_in()
*
- * @param string The field to search
- * @param array The values searched on
- * @param bool If the statement would be IN or NOT IN
- * @param string
+ * @param string $key = NULL The field to search
+ * @param array $values = NULL The values searched on
+ * @param bool $not = FALSE If the statement would be IN or NOT IN
+ * @param string $type = 'AND '
+ * @param bool $escape = NULL
* @return object
*/
protected function _where_in($key = NULL, $values = NULL, $not = FALSE, $type = 'AND ', $escape = NULL)
@@ -1174,9 +1181,10 @@ abstract class CI_DB_query_builder extends CI_DB_driver {
*
* Allows the where clause, limit and offset to be added directly
*
- * @param string the where clause
- * @param string the limit clause
- * @param string the offset clause
+ * @param string $table = ''
+ * @param string $where = NULL
+ * @param int $limit = NULL
+ * @param int $offset = NULL
* @return object
*/
public function get_where($table = '', $where = NULL, $limit = NULL, $offset = NULL)
@@ -1535,9 +1543,10 @@ abstract class CI_DB_query_builder extends CI_DB_driver {
*
* Compiles an update string and runs the query
*
- * @param string the table to retrieve the results from
- * @param array an associative array of update values
- * @param mixed the where clause
+ * @param string $table = ''
+ * @param array $set = NULL an associative array of update values
+ * @param mixed $where = NULL
+ * @param int $limit = NULL
* @return object
*/
public function update($table = '', $set = NULL, $where = NULL, $limit = NULL)
@@ -1967,8 +1976,9 @@ abstract class CI_DB_query_builder extends CI_DB_driver {
* Compile the SELECT statement
*
* Generates a query string based on which functions were used.
- * Should not be called directly. The get() function calls it.
+ * Should not be called directly.
*
+ * @param bool $select_override = FALSE
* @return string
*/
protected function _compile_select($select_override = FALSE)
diff --git a/system/database/DB_result.php b/system/database/DB_result.php
index e747044d8..76093f918 100644
--- a/system/database/DB_result.php
+++ b/system/database/DB_result.php
@@ -251,8 +251,8 @@ class CI_DB_result {
/**
* Query result. Acts as a wrapper function for the following functions.
*
- * @param mixed
- * @param string can be "object" or "array"
+ * @param mixed $n = 0
+ * @param string $type = 'object' 'object' or 'array'
* @return mixed
*/
public function row($n = 0, $type = 'object')
@@ -281,6 +281,8 @@ class CI_DB_result {
/**
* Assigns an item into a particular column slot
*
+ * @param mixed $key
+ * @param mixed $value
* @return void
*/
public function set_row($key, $value = NULL)
@@ -311,6 +313,8 @@ class CI_DB_result {
/**
* Returns a single result row - custom object version
*
+ * @param int $n
+ * @param string $type
* @return object
*/
public function custom_row_object($n, $type)
@@ -335,6 +339,7 @@ class CI_DB_result {
/**
* Returns a single result row - object version
*
+ * @param int $n = 0
* @return object
*/
public function row_object($n = 0)
@@ -358,6 +363,7 @@ class CI_DB_result {
/**
* Returns a single result row - array version
*
+ * @param int $n = 0
* @return array
*/
public function row_array($n = 0)
@@ -381,7 +387,8 @@ class CI_DB_result {
/**
* Returns the "first" row
*
- * @return object
+ * @param string $type = 'object'
+ * @return mixed
*/
public function first_row($type = 'object')
{
@@ -394,7 +401,8 @@ class CI_DB_result {
/**
* Returns the "last" row
*
- * @return object
+ * @param string $type = 'object'
+ * @return mixed
*/
public function last_row($type = 'object')
{
@@ -407,7 +415,8 @@ class CI_DB_result {
/**
* Returns the "next" row
*
- * @return object
+ * @param string $type = 'object'
+ * @return mixed
*/
public function next_row($type = 'object')
{
@@ -430,7 +439,8 @@ class CI_DB_result {
/**
* Returns the "previous" row
*
- * @return object
+ * @param string $type = 'object'
+ * @return mixed
*/
public function previous_row($type = 'object')
{
@@ -452,8 +462,8 @@ class CI_DB_result {
/**
* Returns an unbuffered row and move pointer to next row
*
- * @param string 'array', 'object' or a custom class name
- * @return mixed either a result object or array
+ * @param string $type = 'object' 'array', 'object' or a custom class name
+ * @return mixed
*/
public function unbuffered_row($type = 'object')
{
diff --git a/system/database/DB_utility.php b/system/database/DB_utility.php
index 6a3b40779..8078e2bf6 100644
--- a/system/database/DB_utility.php
+++ b/system/database/DB_utility.php
@@ -41,6 +41,11 @@ abstract class CI_DB_utility extends CI_DB_forge {
protected $_optimize_table = FALSE;
protected $_repair_table = FALSE;
+ /**
+ * Constructor
+ *
+ * @return void
+ */
public function __construct()
{
// Assign the main database object to $this->db
@@ -275,6 +280,7 @@ abstract class CI_DB_utility extends CI_DB_forge {
/**
* Database Backup
*
+ * @param array $params = array()
* @return void
*/
public function backup($params = array())
diff --git a/system/database/drivers/cubrid/cubrid_driver.php b/system/database/drivers/cubrid/cubrid_driver.php
index 7f8f297bb..8e77d8396 100644
--- a/system/database/drivers/cubrid/cubrid_driver.php
+++ b/system/database/drivers/cubrid/cubrid_driver.php
@@ -50,6 +50,12 @@ class CI_DB_cubrid_driver extends CI_DB {
// CUBRID-specific properties
public $auto_commit = TRUE;
+ /**
+ * Constructor
+ *
+ * @param array $params
+ * @return void
+ */
public function __construct($params)
{
parent::__construct($params);
@@ -180,6 +186,7 @@ class CI_DB_cubrid_driver extends CI_DB {
/**
* Begin Transaction
*
+ * @param bool $test_mode = FALSE
* @return bool
*/
public function trans_begin($test_mode = FALSE)
diff --git a/system/database/drivers/cubrid/cubrid_result.php b/system/database/drivers/cubrid/cubrid_result.php
index 4a06a2d39..360c50dc2 100644
--- a/system/database/drivers/cubrid/cubrid_result.php
+++ b/system/database/drivers/cubrid/cubrid_result.php
@@ -132,6 +132,7 @@ class CI_DB_cubrid_result extends CI_DB_result {
* this internally before fetching results to make sure the
* result set starts at zero
*
+ * @param int $n = 0
* @return bool
*/
protected function _data_seek($n = 0)
diff --git a/system/database/drivers/ibase/ibase_driver.php b/system/database/drivers/ibase/ibase_driver.php
index 96d6f6526..c3be519bf 100644
--- a/system/database/drivers/ibase/ibase_driver.php
+++ b/system/database/drivers/ibase/ibase_driver.php
@@ -116,6 +116,7 @@ class CI_DB_ibase_driver extends CI_DB {
/**
* Begin Transaction
*
+ * @param bool $test_mode = FALSE
* @return bool
*/
public function trans_begin($test_mode = FALSE)
diff --git a/system/database/drivers/mssql/mssql_driver.php b/system/database/drivers/mssql/mssql_driver.php
index 3d6cffd29..2063dad90 100644
--- a/system/database/drivers/mssql/mssql_driver.php
+++ b/system/database/drivers/mssql/mssql_driver.php
@@ -50,12 +50,12 @@ class CI_DB_mssql_driver extends CI_DB {
// MSSQL-specific properties
protected $_quoted_identifier = TRUE;
- /*
+ /**
* Constructor
*
* Appends the port number to the hostname, if needed.
*
- * @param array
+ * @param array $params
* @return void
*/
public function __construct($params)
@@ -152,6 +152,7 @@ class CI_DB_mssql_driver extends CI_DB {
/**
* Begin Transaction
*
+ * @param bool $test_mode = FALSE
* @return bool
*/
public function trans_begin($test_mode = FALSE)
diff --git a/system/database/drivers/mssql/mssql_result.php b/system/database/drivers/mssql/mssql_result.php
index aeede3f4b..84d2814f1 100644
--- a/system/database/drivers/mssql/mssql_result.php
+++ b/system/database/drivers/mssql/mssql_result.php
@@ -133,6 +133,7 @@ class CI_DB_mssql_result extends CI_DB_result {
* this internally before fetching results to make sure the
* result set starts at zero
*
+ * @param int $n = 0
* @return bool
*/
protected function _data_seek($n = 0)
diff --git a/system/database/drivers/mysql/mysql_driver.php b/system/database/drivers/mysql/mysql_driver.php
index ce9f73011..f82e775e6 100644
--- a/system/database/drivers/mysql/mysql_driver.php
+++ b/system/database/drivers/mysql/mysql_driver.php
@@ -214,6 +214,7 @@ class CI_DB_mysql_driver extends CI_DB {
/**
* Begin Transaction
*
+ * @param bool $test_mode = FALSE
* @return bool
*/
public function trans_begin($test_mode = FALSE)
diff --git a/system/database/drivers/mysql/mysql_result.php b/system/database/drivers/mysql/mysql_result.php
index 7fbb65496..b3f669e40 100644
--- a/system/database/drivers/mysql/mysql_result.php
+++ b/system/database/drivers/mysql/mysql_result.php
@@ -146,6 +146,7 @@ class CI_DB_mysql_result extends CI_DB_result {
* this internally before fetching results to make sure the
* result set starts at zero
*
+ * @param int $n = 0
* @return bool
*/
protected function _data_seek($n = 0)
diff --git a/system/database/drivers/mysqli/mysqli_driver.php b/system/database/drivers/mysqli/mysqli_driver.php
index 91ab13a3c..6c4f87513 100644
--- a/system/database/drivers/mysqli/mysqli_driver.php
+++ b/system/database/drivers/mysqli/mysqli_driver.php
@@ -196,6 +196,7 @@ class CI_DB_mysqli_driver extends CI_DB {
/**
* Begin Transaction
*
+ * @param bool $test_mode = FALSE
* @return bool
*/
public function trans_begin($test_mode = FALSE)
diff --git a/system/database/drivers/mysqli/mysqli_result.php b/system/database/drivers/mysqli/mysqli_result.php
index c1ec4da76..f036302bb 100644
--- a/system/database/drivers/mysqli/mysqli_result.php
+++ b/system/database/drivers/mysqli/mysqli_result.php
@@ -132,6 +132,7 @@ class CI_DB_mysqli_result extends CI_DB_result {
* this internally before fetching results to make sure the
* result set starts at zero
*
+ * @param int $n = 0
* @return bool
*/
protected function _data_seek($n = 0)
diff --git a/system/database/drivers/oci8/oci8_driver.php b/system/database/drivers/oci8/oci8_driver.php
index 8e4f4ef9d..81d73d073 100644
--- a/system/database/drivers/oci8/oci8_driver.php
+++ b/system/database/drivers/oci8/oci8_driver.php
@@ -75,6 +75,12 @@ class CI_DB_oci8_driver extends CI_DB {
// throw off num_fields later
public $limit_used;
+ /**
+ * Constructor
+ *
+ * @param array $params
+ * @return void
+ */
public function __construct($params)
{
parent::__construct($params);
diff --git a/system/database/drivers/odbc/odbc_driver.php b/system/database/drivers/odbc/odbc_driver.php
index 741b7419f..063a04b98 100644
--- a/system/database/drivers/odbc/odbc_driver.php
+++ b/system/database/drivers/odbc/odbc_driver.php
@@ -49,6 +49,12 @@ class CI_DB_odbc_driver extends CI_DB {
protected $_random_keyword;
+ /**
+ * Constructor
+ *
+ * @param array $params
+ * @return void
+ */
public function __construct($params)
{
parent::__construct($params);
@@ -62,6 +68,8 @@ class CI_DB_odbc_driver extends CI_DB {
}
}
+ // --------------------------------------------------------------------
+
/**
* Non-persistent database connection
*
@@ -102,6 +110,7 @@ class CI_DB_odbc_driver extends CI_DB {
/**
* Begin Transaction
*
+ * @param bool $test_mode = FALSE
* @return bool
*/
public function trans_begin($test_mode = FALSE)
diff --git a/system/database/drivers/pdo/pdo_driver.php b/system/database/drivers/pdo/pdo_driver.php
index f4509b17c..32a9e7509 100644
--- a/system/database/drivers/pdo/pdo_driver.php
+++ b/system/database/drivers/pdo/pdo_driver.php
@@ -57,7 +57,7 @@ class CI_DB_pdo_driver extends CI_DB {
*
* Validates the DSN string and/or detects the subdriver
*
- * @param array
+ * @param array $params
* @return void
*/
public function __construct($params)
@@ -183,6 +183,7 @@ class CI_DB_pdo_driver extends CI_DB {
/**
* Begin Transaction
*
+ * @param bool $test_mode = FALSE
* @return bool
*/
public function trans_begin($test_mode = FALSE)
diff --git a/system/database/drivers/postgre/postgre_driver.php b/system/database/drivers/postgre/postgre_driver.php
index 19f384ccc..1b9474920 100644
--- a/system/database/drivers/postgre/postgre_driver.php
+++ b/system/database/drivers/postgre/postgre_driver.php
@@ -51,6 +51,7 @@ class CI_DB_postgre_driver extends CI_DB {
*
* Creates a DSN string to be used for db_connect() and db_pconnect()
*
+ * @param array $params
* @return void
*/
public function __construct($params)
diff --git a/system/database/drivers/postgre/postgre_forge.php b/system/database/drivers/postgre/postgre_forge.php
index c434e9510..1164d9bb3 100644
--- a/system/database/drivers/postgre/postgre_forge.php
+++ b/system/database/drivers/postgre/postgre_forge.php
@@ -39,7 +39,8 @@ class CI_DB_postgre_forge extends CI_DB_forge {
/**
* Process Fields
*
- * @param mixed the fields
+ * @param mixed $fields
+ * @param array $primary_keys = array()
* @return string
*/
protected function _process_fields($fields, $primary_keys = array())
@@ -190,13 +191,10 @@ class CI_DB_postgre_forge extends CI_DB_forge {
* Generates a platform-specific query so that a table can be altered
* Called by add_column(), drop_column(), and column_alter(),
*
- * @param string the ALTER type (ADD, DROP, CHANGE)
- * @param string the column name
- * @param string the table name
- * @param string the column definition
- * @param string the default value
- * @param bool should 'NOT NULL' be added
- * @param string the field after which we should add the new field
+ * @param string $alter_type the ALTER type (ADD, DROP, CHANGE)
+ * @param string $table the table name
+ * @param string $fields the column definition
+ * @param string $after_field = ''
* @return string
*/
protected function _alter_table($alter_type, $table, $fields, $after_field = '')
diff --git a/system/database/drivers/postgre/postgre_result.php b/system/database/drivers/postgre/postgre_result.php
index eb9d647e7..458ae869c 100644
--- a/system/database/drivers/postgre/postgre_result.php
+++ b/system/database/drivers/postgre/postgre_result.php
@@ -131,6 +131,7 @@ class CI_DB_postgre_result extends CI_DB_result {
* this internally before fetching results to make sure the
* result set starts at zero
*
+ * @param int $n = 0
* @return bool
*/
protected function _data_seek($n = 0)
diff --git a/system/database/drivers/sqlite/sqlite_driver.php b/system/database/drivers/sqlite/sqlite_driver.php
index 2744a63cf..2fd39346f 100644
--- a/system/database/drivers/sqlite/sqlite_driver.php
+++ b/system/database/drivers/sqlite/sqlite_driver.php
@@ -127,6 +127,7 @@ class CI_DB_sqlite_driver extends CI_DB {
/**
* Begin Transaction
*
+ * @param bool $test_mode = FALSE
* @return bool
*/
public function trans_begin($test_mode = FALSE)
diff --git a/system/database/drivers/sqlite/sqlite_result.php b/system/database/drivers/sqlite/sqlite_result.php
index eef9787a1..214841412 100644
--- a/system/database/drivers/sqlite/sqlite_result.php
+++ b/system/database/drivers/sqlite/sqlite_result.php
@@ -115,6 +115,7 @@ class CI_DB_sqlite_result extends CI_DB_result {
* this internally before fetching results to make sure the
* result set starts at zero
*
+ * @param int $n = 0
* @return bool
*/
protected function _data_seek($n = 0)
diff --git a/system/database/drivers/sqlite3/sqlite3_driver.php b/system/database/drivers/sqlite3/sqlite3_driver.php
index d03be15f5..22c72b9b8 100644
--- a/system/database/drivers/sqlite3/sqlite3_driver.php
+++ b/system/database/drivers/sqlite3/sqlite3_driver.php
@@ -103,13 +103,12 @@ class CI_DB_sqlite3_driver extends CI_DB {
/**
* Execute the query
*
- * @param string an SQL query
+ * @todo Implement use of SQLite3::querySingle(), if needed
+ * @param string $sql
* @return mixed SQLite3Result object or bool
*/
protected function _execute($sql)
{
- // TODO: Implement use of SQLite3::querySingle(), if needed
-
return $this->is_write_type($sql)
? $this->conn_id->exec($sql)
: $this->conn_id->query($sql);
@@ -120,6 +119,7 @@ class CI_DB_sqlite3_driver extends CI_DB {
/**
* Begin Transaction
*
+ * @param bool $test_mode = FALSE
* @return bool
*/
public function trans_begin($test_mode = FALSE)
diff --git a/system/database/drivers/sqlite3/sqlite3_result.php b/system/database/drivers/sqlite3/sqlite3_result.php
index 117fb3ce8..35aecda36 100644
--- a/system/database/drivers/sqlite3/sqlite3_result.php
+++ b/system/database/drivers/sqlite3/sqlite3_result.php
@@ -167,6 +167,7 @@ class CI_DB_sqlite3_result extends CI_DB_result {
* this internally before fetching results to make sure the
* result set starts at zero
*
+ * @param $n = 0 (ignored)
* @return array
*/
protected function _data_seek($n = 0)
diff --git a/system/database/drivers/sqlsrv/sqlsrv_driver.php b/system/database/drivers/sqlsrv/sqlsrv_driver.php
index 8f615223c..32f1a59d6 100644
--- a/system/database/drivers/sqlsrv/sqlsrv_driver.php
+++ b/system/database/drivers/sqlsrv/sqlsrv_driver.php
@@ -53,6 +53,7 @@ class CI_DB_sqlsrv_driver extends CI_DB {
/**
* Non-persistent database connection
*
+ * @param bool $pooling = FALSE
* @return resource
*/
public function db_connect($pooling = FALSE)
@@ -144,6 +145,7 @@ class CI_DB_sqlsrv_driver extends CI_DB {
/**
* Begin Transaction
*
+ * @param bool $test_mode = FALSE
* @return bool
*/
public function trans_begin($test_mode = FALSE)