Improve docs
This commit is contained in:
Michal Čihař
parent
ddec158385
commit
3308e16db4
@ -55,12 +55,12 @@ function PMA_DBI_real_connect($server, $user, $password, $client_flags, $persist
|
||||
/**
|
||||
* connects to the database server
|
||||
*
|
||||
* @param string $user mysql user name
|
||||
* @param string $password mysql user password
|
||||
* @param bool $is_controluser
|
||||
* @param array $server host/port/socket/persistent
|
||||
* @param bool $auxiliary_connection (when true, don't go back to login if connection fails)
|
||||
* @return mixed false on error or a mysqli object on success
|
||||
* @param string $user mysql user name
|
||||
* @param string $password mysql user password
|
||||
* @param bool $is_controluser
|
||||
* @param array $server host/port/socket/persistent
|
||||
* @param bool $auxiliary_connection (when true, don't go back to login if connection fails)
|
||||
* @return mixed false on error or a mysqli object on success
|
||||
*/
|
||||
function PMA_DBI_connect($user, $password, $is_controluser = false, $server = null, $auxiliary_connection = false)
|
||||
{
|
||||
@ -137,8 +137,8 @@ function PMA_DBI_connect($user, $password, $is_controluser = false, $server = nu
|
||||
/**
|
||||
* selects given database
|
||||
*
|
||||
* @param string $dbname name of db to select
|
||||
* @param resource $link mysql link resource
|
||||
* @param string $dbname name of db to select
|
||||
* @param resource $link mysql link resource
|
||||
* @return bool
|
||||
*/
|
||||
function PMA_DBI_select_db($dbname, $link = null)
|
||||
@ -156,9 +156,9 @@ function PMA_DBI_select_db($dbname, $link = null)
|
||||
/**
|
||||
* runs a query and returns the result
|
||||
*
|
||||
* @param string $query query to run
|
||||
* @param resource $link mysql link resource
|
||||
* @param int $options
|
||||
* @param string $query query to run
|
||||
* @param resource $link mysql link resource
|
||||
* @param int $options query options
|
||||
* @return mixed
|
||||
*/
|
||||
function PMA_DBI_real_query($query, $link, $options)
|
||||
@ -175,8 +175,8 @@ function PMA_DBI_real_query($query, $link, $options)
|
||||
/**
|
||||
* returns array of rows with associative and numeric keys from $result
|
||||
*
|
||||
* @param resource $result
|
||||
* @return array
|
||||
* @param resource $result result MySQL result
|
||||
* @return array
|
||||
*/
|
||||
function PMA_DBI_fetch_array($result)
|
||||
{
|
||||
@ -186,8 +186,8 @@ function PMA_DBI_fetch_array($result)
|
||||
/**
|
||||
* returns array of rows with associative keys from $result
|
||||
*
|
||||
* @param resource $result
|
||||
* @return array
|
||||
* @param resource $result MySQL result
|
||||
* @return array
|
||||
*/
|
||||
function PMA_DBI_fetch_assoc($result)
|
||||
{
|
||||
@ -197,8 +197,8 @@ function PMA_DBI_fetch_assoc($result)
|
||||
/**
|
||||
* returns array of rows with numeric keys from $result
|
||||
*
|
||||
* @param resource $result
|
||||
* @return array
|
||||
* @param resource $result MySQL result
|
||||
* @return array
|
||||
*/
|
||||
function PMA_DBI_fetch_row($result)
|
||||
{
|
||||
@ -208,9 +208,9 @@ function PMA_DBI_fetch_row($result)
|
||||
/**
|
||||
* Adjusts the result pointer to an arbitrary row in the result
|
||||
*
|
||||
* @param $result
|
||||
* @param $offset
|
||||
* @return bool true on success, false on failure
|
||||
* @param $result
|
||||
* @param $offset
|
||||
* @return bool true on success, false on failure
|
||||
*/
|
||||
function PMA_DBI_data_seek($result, $offset)
|
||||
{
|
||||
@ -220,7 +220,7 @@ function PMA_DBI_data_seek($result, $offset)
|
||||
/**
|
||||
* Frees memory associated with the result
|
||||
*
|
||||
* @param resource $result
|
||||
* @param resource $result
|
||||
*/
|
||||
function PMA_DBI_free_result($result)
|
||||
{
|
||||
@ -232,7 +232,7 @@ function PMA_DBI_free_result($result)
|
||||
/**
|
||||
* Check if there are any more query results from a multi query
|
||||
*
|
||||
* @return bool false
|
||||
* @return bool false
|
||||
*/
|
||||
function PMA_DBI_more_results()
|
||||
{
|
||||
@ -246,7 +246,7 @@ function PMA_DBI_more_results()
|
||||
/**
|
||||
* Prepare next result from multi_query
|
||||
*
|
||||
* @return boo false
|
||||
* @return boo false
|
||||
*/
|
||||
function PMA_DBI_next_result()
|
||||
{
|
||||
@ -260,8 +260,8 @@ function PMA_DBI_next_result()
|
||||
/**
|
||||
* Returns a string representing the type of connection used
|
||||
*
|
||||
* @param resource $link mysql link
|
||||
* @return string type of connection used
|
||||
* @param resource $link mysql link
|
||||
* @return string type of connection used
|
||||
*/
|
||||
function PMA_DBI_get_host_info($link = null)
|
||||
{
|
||||
@ -278,8 +278,8 @@ function PMA_DBI_get_host_info($link = null)
|
||||
/**
|
||||
* Returns the version of the MySQL protocol used
|
||||
*
|
||||
* @param resource $link mysql link
|
||||
* @return int version of the MySQL protocol used
|
||||
* @param resource $link mysql link
|
||||
* @return int version of the MySQL protocol used
|
||||
*/
|
||||
function PMA_DBI_get_proto_info($link = null)
|
||||
{
|
||||
@ -296,7 +296,7 @@ function PMA_DBI_get_proto_info($link = null)
|
||||
/**
|
||||
* returns a string that represents the client library version
|
||||
*
|
||||
* @return string MySQL client library version
|
||||
* @return string MySQL client library version
|
||||
*/
|
||||
function PMA_DBI_get_client_info()
|
||||
{
|
||||
@ -306,8 +306,8 @@ function PMA_DBI_get_client_info()
|
||||
/**
|
||||
* returns last error message or false if no errors occured
|
||||
*
|
||||
* @param resource $link mysql link
|
||||
* @return string|bool $error or false
|
||||
* @param resource $link mysql link
|
||||
* @return string|bool $error or false
|
||||
*/
|
||||
function PMA_DBI_getError($link = null)
|
||||
{
|
||||
@ -347,8 +347,8 @@ function PMA_DBI_getError($link = null)
|
||||
/**
|
||||
* returns the number of rows returned by last query
|
||||
*
|
||||
* @param resource $result
|
||||
* @return string|int
|
||||
* @param resource $result MySQL result
|
||||
* @return string|int
|
||||
*/
|
||||
function PMA_DBI_num_rows($result)
|
||||
{
|
||||
@ -362,8 +362,8 @@ function PMA_DBI_num_rows($result)
|
||||
/**
|
||||
* returns last inserted auto_increment id for given $link or $GLOBALS['userlink']
|
||||
*
|
||||
* @param resource $link the mysql object
|
||||
* @return string|int
|
||||
* @param resource $link the mysql object
|
||||
* @return string|int
|
||||
*/
|
||||
function PMA_DBI_insert_id($link = null)
|
||||
{
|
||||
@ -385,9 +385,9 @@ function PMA_DBI_insert_id($link = null)
|
||||
/**
|
||||
* returns the number of rows affected by last query
|
||||
*
|
||||
* @param resource $link the mysql object
|
||||
* @param bool $get_from_cache
|
||||
* @return string|int
|
||||
* @param resource $link the mysql object
|
||||
* @param bool $get_from_cache
|
||||
* @return string|int
|
||||
*/
|
||||
function PMA_DBI_affected_rows($link = null, $get_from_cache = true)
|
||||
{
|
||||
@ -410,8 +410,8 @@ function PMA_DBI_affected_rows($link = null, $get_from_cache = true)
|
||||
* returns metainfo for fields in $result
|
||||
*
|
||||
* @todo add missing keys like in mysqli_query (decimals)
|
||||
* @param resource $result
|
||||
* @return array meta info for fields in $result
|
||||
* @param resource $result MySQL result
|
||||
* @return array meta info for fields in $result
|
||||
*/
|
||||
function PMA_DBI_get_fields_meta($result)
|
||||
{
|
||||
@ -430,7 +430,7 @@ function PMA_DBI_get_fields_meta($result)
|
||||
/**
|
||||
* return number of fields in given $result
|
||||
*
|
||||
* @param resource $result
|
||||
* @param resource $result MySQL result
|
||||
* @return int field count
|
||||
*/
|
||||
function PMA_DBI_num_fields($result)
|
||||
@ -441,9 +441,9 @@ function PMA_DBI_num_fields($result)
|
||||
/**
|
||||
* returns the length of the given field $i in $result
|
||||
*
|
||||
* @param resource $result
|
||||
* @param int $i field
|
||||
* @return int length of field
|
||||
* @param resource $result MySQL result
|
||||
* @param int $i field
|
||||
* @return int length of field
|
||||
*/
|
||||
function PMA_DBI_field_len($result, $i)
|
||||
{
|
||||
@ -453,9 +453,9 @@ function PMA_DBI_field_len($result, $i)
|
||||
/**
|
||||
* returns name of $i. field in $result
|
||||
*
|
||||
* @param resource $result
|
||||
* @param int $i field
|
||||
* @return string name of $i. field in $result
|
||||
* @param resource $result MySQL result
|
||||
* @param int $i field
|
||||
* @return string name of $i. field in $result
|
||||
*/
|
||||
function PMA_DBI_field_name($result, $i)
|
||||
{
|
||||
@ -465,9 +465,9 @@ function PMA_DBI_field_name($result, $i)
|
||||
/**
|
||||
* returns concatenated string of human readable field flags
|
||||
*
|
||||
* @param resource $result
|
||||
* @param int $i field
|
||||
* @return string field flags
|
||||
* @param resource $result MySQL result
|
||||
* @param int $i field
|
||||
* @return string field flags
|
||||
*/
|
||||
function PMA_DBI_field_flags($result, $i)
|
||||
{
|
||||
|
||||
Loading…
Reference in New Issue
Block a user
