gian/phpmyadmin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add some docblocks

Browse Source
This commit is contained in:
Michal Čihař 2011-08-05 10:15:35 +02:00
parent 754a42bcb5
commit 8880f996bf
1 changed files with 30 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
libraries/blobstreaming.lib.php
View File

@ -228,15 +228,25 @@ function PMA_BS_GetVariables()
return $BS_Variables;
}
//========================
//========================
/**
* Retrieves and shows PBMS error.
*
* @return nothing
*/
function PMA_BS_ReportPBMSError($msg)
{
$tmp_err = pbms_error();
PMA_showMessage(__('PBMS error') . " $msg $tmp_err");
}
//------------
/**
* Tries to connect to PBMS server.
*
* @param string $db_name Database name
* @param bool $quiet Whether to report errors
*
* @return bool Connection status.
*/
function PMA_do_connect($db_name, $quiet)
{
$PMA_Config = $GLOBALS['PMA_Config'];
@ -266,17 +276,24 @@ function PMA_do_connect($db_name, $quiet)
return true;
}
//------------
/**
* Disconnects from PBMS server.
*
* @return nothing
*/
function PMA_do_disconnect()
{
pbms_close();
}
//------------
/**
* checks whether the BLOB reference looks valid
* Checks whether the BLOB reference looks valid
*
*/
* @param string $bs_reference BLOB reference
* @param string $db_name Database name
*
* @return bool True on success.
*/
function PMA_BS_IsPBMSReference($bs_reference, $db_name)
{
if (PMA_cacheGet('skip_blobstreaming', true)) {
@ -357,11 +374,12 @@ function PMA_BS_CreateReferenceLink($bs_reference, $db_name)
return $output;
}
//------------
// In the future there may be server variables to turn on/off PBMS
// BLOB streaming on a per table or database basis. So in anticipation of this
// PMA_BS_IsTablePBMSEnabled() passes in the table and database name even though
// they are not currently needed.
/**
* In the future there may be server variables to turn on/off PBMS
* BLOB streaming on a per table or database basis. So in anticipation of this
* PMA_BS_IsTablePBMSEnabled() passes in the table and database name even though
* they are not currently needed.
*/
function PMA_BS_IsTablePBMSEnabled($db_name, $tbl_name, $tbl_type)
{
if (PMA_cacheGet('skip_blobstreaming', true)) {