From 5c461bada970c336616b0c03c9036f89cab21d0c Mon Sep 17 00:00:00 2001
From: alecpl <alec@alec.pl>
Date: Wed, 29 Sep 2010 12:47:05 -0400
Subject: [PATCH] - Update phpdoc (#1486958)
---
program/include/rcube_mdb2.php | 68 +++++++++++++++++-----------------
1 files changed, 34 insertions(+), 34 deletions(-)
diff --git a/program/include/rcube_mdb2.php b/program/include/rcube_mdb2.php
index a2baf33..3aaf3bd 100644
--- a/program/include/rcube_mdb2.php
+++ b/program/include/rcube_mdb2.php
@@ -52,8 +52,8 @@
/**
* Object constructor
*
- * @param string DSN for read/write operations
- * @param string Optional DSN for read only operations
+ * @param string $db_dsnw DSN for read/write operations
+ * @param string $db_dsnr Optional DSN for read only operations
*/
function __construct($db_dsnw, $db_dsnr='', $pconn=false)
{
@@ -72,8 +72,8 @@
/**
* Connect to specific database
*
- * @param string DSN for DB connections
- * @return object PEAR database handle
+ * @param string $dsn DSN for DB connections
+ * @return MDB2 PEAR database handle
* @access private
*/
private function dsn_connect($dsn)
@@ -116,7 +116,7 @@
/**
* Connect to appropiate database depending on the operation
*
- * @param string Connection mode (r|w)
+ * @param string $mode Connection mode (r|w)
* @access public
*/
function db_connect($mode)
@@ -149,7 +149,7 @@
/**
* Activate/deactivate debug mode
*
- * @param boolean True if SQL queries should be logged
+ * @param boolean $dbg True if SQL queries should be logged
* @access public
*/
function set_debug($dbg = true)
@@ -227,10 +227,10 @@
/**
* Execute a SQL query with limits
*
- * @param string SQL query to execute
- * @param number Offset for LIMIT statement
- * @param number Number of rows for LIMIT statement
- * @param array Values to be inserted in query
+ * @param string $query SQL query to execute
+ * @param number $offset Offset for LIMIT statement
+ * @param number $numrows Number of rows for LIMIT statement
+ * @param array $params Values to be inserted in query
* @return number Query handle identifier
* @access private
*/
@@ -279,7 +279,7 @@
* Get number of rows for a SQL query
* If no query handle is specified, the last query will be taken as reference
*
- * @param number Optional query handle identifier
+ * @param number $res_id Optional query handle identifier
* @return mixed Number of rows or false on failure
* @access public
*/
@@ -298,7 +298,7 @@
/**
* Get number of affected rows for the last query
*
- * @param number Optional query handle identifier
+ * @param number $res_id Optional query handle identifier
* @return mixed Number of rows or false on failure
* @access public
*/
@@ -315,7 +315,7 @@
* Get last inserted record ID
* For Postgres databases, a sequence name is required
*
- * @param string Table name (to find the incremented sequence)
+ * @param string $table Table name (to find the incremented sequence)
* @return mixed ID or false on failure
* @access public
*/
@@ -343,7 +343,7 @@
* Get an associative array for one row
* If no query handle is specified, the last query will be taken as reference
*
- * @param number Optional query handle identifier
+ * @param number $res_id Optional query handle identifier
* @return mixed Array with col values or false on failure
* @access public
*/
@@ -358,7 +358,7 @@
* Get an index array for one row
* If no query handle is specified, the last query will be taken as reference
*
- * @param number Optional query handle identifier
+ * @param number $res_id Optional query handle identifier
* @return mixed Array with col values or false on failure
* @access public
*/
@@ -372,8 +372,8 @@
/**
* Get col values for a result row
*
- * @param object Query result handle
- * @param number Fetch mode identifier
+ * @param MDB2_Result_Common Query $result result handle
+ * @param number $mode Fetch mode identifier
* @return mixed Array with col values or false on failure
* @access private
*/
@@ -411,8 +411,8 @@
/**
* Formats input so it can be safely used in a query
*
- * @param mixed Value to quote
- * @param string Type of data
+ * @param mixed $input Value to quote
+ * @param string $type Type of data
* @return string Quoted/converted string for use in query
* @access public
*/
@@ -433,7 +433,7 @@
/**
* Quotes a string so it can be safely used as a table or column name
*
- * @param string Value to quote
+ * @param string $str Value to quote
* @return string Quoted string for use in query
* @deprecated Replaced by rcube_MDB2::quote_identifier
* @see rcube_mdb2::quote_identifier
@@ -448,7 +448,7 @@
/**
* Quotes a string so it can be safely used as a table or column name
*
- * @param string Value to quote
+ * @param string $str Value to quote
* @return string Quoted string for use in query
* @access public
*/
@@ -464,7 +464,7 @@
/**
* Escapes a string
*
- * @param string The string to be escaped
+ * @param string $str The string to be escaped
* @return string The escaped string
* @access public
* @since 0.1.1
@@ -500,8 +500,8 @@
/**
* Return list of elements for use with SQL's IN clause
*
- * @param array Input array
- * @param string Type of data
+ * @param array $arr Input array
+ * @param string $type Type of data
* @return string Comma-separated list of quoted values for use in query
* @access public
*/
@@ -520,7 +520,7 @@
/**
* Return SQL statement to convert a field value into a unix timestamp
*
- * @param string Field name
+ * @param string $field Field name
* @return string SQL statement to use in query
* @access public
*/
@@ -543,7 +543,7 @@
/**
* Return SQL statement to convert from a unix timestamp
*
- * @param string Field name
+ * @param string $timestamp Field name
* @return string SQL statement to use in query
* @access public
*/
@@ -564,8 +564,8 @@
/**
* Return SQL statement for case insensitive LIKE
*
- * @param string Field name
- * @param string Search value
+ * @param string $column Field name
+ * @param string $value Search value
* @return string SQL statement to use in query
* @access public
*/
@@ -584,7 +584,7 @@
/**
* Encodes non-UTF-8 characters in string/array/object (recursive)
*
- * @param mixed Data to fix
+ * @param mixed $input Data to fix
* @return mixed Properly UTF-8 encoded data
* @access public
*/
@@ -608,7 +608,7 @@
/**
* Decodes encoded UTF-8 string/object/array (recursive)
*
- * @param mixed Input data
+ * @param mixed $input Input data
* @return mixed Decoded data
* @access public
*/
@@ -632,7 +632,7 @@
/**
* Adds a query result and returns a handle ID
*
- * @param object Query handle
+ * @param object $res Query handle
* @return mixed Handle ID
* @access private
*/
@@ -660,7 +660,7 @@
* Resolves a given handle ID and returns the according query handle
* If no ID is specified, the last resource handle will be returned
*
- * @param number Handle ID
+ * @param number $res_id Handle ID
* @return mixed Resource handle or false on failure
* @access private
*/
@@ -680,8 +680,8 @@
/**
* Create a sqlite database from a file
*
- * @param object SQLite database handle
- * @param string File path to use for DB creation
+ * @param MDB2 $dbh SQLite database handle
+ * @param string $file_name File path to use for DB creation
* @access private
*/
private function _sqlite_create_database($dbh, $file_name)
--
Gitblit v1.9.1