Index: branches/5.3.x/core/kernel/db/db_connection.php =================================================================== diff -u -N -r15919 -r15922 --- branches/5.3.x/core/kernel/db/db_connection.php (.../db_connection.php) (revision 15919) +++ branches/5.3.x/core/kernel/db/db_connection.php (.../db_connection.php) (revision 15922) @@ -1,6 +1,6 @@ dbType . '_' . $name; } - /** - * Try to connect to database server - * using specified parameters and set - * database to $db if connection made + * Try to connect to database server using specified parameters and set database to $db if connection made. * * @param string $host * @param string $user * @param string $pass * @param string $db - * @param bool $force_new - * @param bool $retry + * @param bool $force_new + * @param bool $retry + * * @return bool * @access public + * @throws RuntimeException When connection failed. */ public function Connect($host, $user, $pass, $db, $force_new = false, $retry = false) { @@ -314,7 +312,7 @@ } /** - * Checks if connection to database is opened + * Checks if connection to database is opened. * * @return bool * @access public @@ -325,7 +323,7 @@ } /** - * Setups the connection according given configuration + * Setups the connection according given configuration. * * @param Array $config * @return bool @@ -499,9 +497,7 @@ } /** - * Returns first field of first line - * of recordset if query ok or false - * otherwise + * Returns first field of first line of recordset if query ok or false otherwise. * * @param string $sql * @param int $offset @@ -520,8 +516,7 @@ } /** - * Returns first row of recordset - * if query ok, false otherwise + * Returns first row of recordset if query ok, false otherwise. * * @param string $sql * @param int $offset @@ -541,12 +536,10 @@ } /** - * Returns 1st column of recordset as - * one-dimensional array or false otherwise - * Optional parameter $key_field can be used - * to set field name to be used as resulting - * array key + * Returns 1st column of recordset as one-dimensional array or false otherwise. * + * Optional parameter $key_field can be used to set field name to be used as resulting array key. + * * @param string $sql * @param string $key_field * @return Array @@ -581,9 +574,9 @@ /** * Returns iterator for 1st column of a recordset or false in case of error. - * Optional parameter $key_field can be used to set field name to be used - * as resulting array key. * + * Optional parameter $key_field can be used to set field name to be used as resulting array key. + * * @param string $sql * @param string $key_field * @return bool|kMySQLQueryCol @@ -594,12 +587,10 @@ } /** - * Queries db with $sql query supplied - * and returns rows selected if any, false - * otherwise. Optional parameter $key_field - * allows to set one of the query fields - * value as key in string array. + * Queries db with $sql query supplied and returns rows selected if any, false otherwise. * + * Optional parameter $key_field allows to set one of the query fields value as key in string array. + * * @param string $sql * @param string $key_field * @param bool $no_debug @@ -663,13 +654,14 @@ } /** - * Returns iterator to a recordset, produced from running $sql query Queries db with $sql query supplied and returns kMySQLQuery iterator - * or false in case of error. Optional parameter $key_field allows to - * set one of the query fields value as key in string array. + * Returns iterator to a recordset, produced from running $sql query. * + * Queries db with $sql query supplied and returns kMySQLQuery iterator or false in case of error. + * Optional parameter $key_field allows to set one of the query fields value as key in string array. + * * @param string $sql * @param string $key_field - * @param bool $no_debug + * @param bool $no_debug * @param string $iterator_class * @return kMySQLQuery|bool * @access public @@ -718,7 +710,7 @@ } /** - * Free memory used to hold recordset handle + * Free memory used to hold recordset handle. * * @access public */ @@ -731,7 +723,7 @@ } /** - * Performs sql query, that will change database content + * Performs sql query, that will change database content. * * @param string $sql * @return bool @@ -745,8 +737,7 @@ } /** - * Returns auto increment field value from - * insert like operation if any, zero otherwise + * Returns auto increment field value from insert like operation if any, zero otherwise. * * @return int * @access public @@ -758,7 +749,7 @@ } /** - * Returns row count affected by last query + * Returns row count affected by last query. * * @return int * @access public @@ -770,7 +761,7 @@ } /** - * Returns LIMIT sql clause part for specific db + * Returns LIMIT sql clause part for specific db. * * @param int $offset * @param int $rows @@ -791,8 +782,7 @@ } /** - * If it's a string, adds quotes and backslashes (only work since PHP 4.3.0) - * Otherwise returns as-is + * If it's a string, adds quotes and backslashes. Otherwise returns as-is. * * @param mixed $string * @return string @@ -812,7 +802,7 @@ } /** - * Calls "qstr" function for each given array element + * Calls "qstr" function for each given array element. * * @param Array $array * @param string $function @@ -824,7 +814,7 @@ } /** - * Escapes strings (only work since PHP 4.3.0) + * Escapes string. * * @param mixed $string * @return string @@ -843,7 +833,7 @@ } /** - * Returns last error code occurred + * Returns last error code occurred. * * @return int * @access public @@ -854,7 +844,7 @@ } /** - * Returns last error message + * Returns last error message. * * @return string * @access public @@ -866,7 +856,7 @@ /** * Performs insert of given data (useful with small number of queries) - * or stores it to perform multiple insert later (useful with large number of queries) + * or stores it to perform multiple insert later (useful with large number of queries). * * @param Array $fields_hash * @param string $table @@ -909,7 +899,7 @@ } /** - * Update given field values to given record using $key_clause + * Update given field values to given record using $key_clause. * * @param Array $fields_hash * @param string $table @@ -935,7 +925,7 @@ } /** - * Allows to detect table's presence in database + * Allows to detect table's presence in database. * * @param string $table_name * @param bool $force @@ -967,7 +957,7 @@ } /** - * Returns query processing statistics + * Returns query processing statistics. * * @return Array * @access public @@ -978,7 +968,7 @@ } /** - * Get status information from SHOW STATUS in an associative array + * Get status information from SHOW STATUS in an associative array. * * @param string $which * @return Array @@ -1081,12 +1071,10 @@ } /** - * Queries db with $sql query supplied - * and returns rows selected if any, false - * otherwise. Optional parameter $key_field - * allows to set one of the query fields - * value as key in string array. + * Queries db with $sql query supplied and returns rows selected if any, false otherwise. * + * Optional parameter $key_field allows to set one of the query fields value as key in string array. + * * @param string $sql * @param string $key_field * @param bool $no_debug @@ -1164,13 +1152,14 @@ } /** - * Queries db with $sql query supplied and returns kMySQLQuery iterator - * or false in case of error. Optional parameter $key_field allows to - * set one of the query fields value as key in string array. + * Returns iterator to a recordset, produced from running $sql query. * + * Queries db with $sql query supplied and returns kMySQLQuery iterator or false in case of error. + * Optional parameter $key_field allows to set one of the query fields value as key in string array. + * * @param string $sql * @param string $key_field - * @param bool $no_debug + * @param bool $no_debug * @param string $iterator_class * @return kMySQLQuery|bool * @access public