[Phpmyadmin-git] [SCM] phpMyAdmin branch, master, updated. RELEASE_3_4_3_1-13121-g4833db7

[Michal Čihař]

The branch, master has been updated
       via  4833db7d64236ae44d240d1b49841b00d650775a (commit)
       via  8880f996bf51f2973b9b84f6bd03207a3cbf270b (commit)
      from  754a42bcb57f4ed81d81ab6a5612f3a588c23612 (commit)


- Log -----------------------------------------------------------------
commit 4833db7d64236ae44d240d1b49841b00d650775a
Author: Michal Čihař <mcihar at suse.cz>
Date:   Fri Aug 5 10:17:16 2011 +0200

    Add some docblocks

commit 8880f996bf51f2973b9b84f6bd03207a3cbf270b
Author: Michal Čihař <mcihar at suse.cz>
Date:   Fri Aug 5 10:15:35 2011 +0200

    Add some docblocks

-----------------------------------------------------------------------

Summary of changes:
 libraries/blobstreaming.lib.php                |   42 +++++++++++++++++-------
 libraries/schema/Pdf_Relation_Schema.class.php |   19 ++++++++--
 2 files changed, 45 insertions(+), 16 deletions(-)

diff --git a/libraries/blobstreaming.lib.php b/libraries/blobstreaming.lib.php
index 301403c..1eeaae2 100644
--- a/libraries/blobstreaming.lib.php
+++ b/libraries/blobstreaming.lib.php
@@ -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)) {
diff --git a/libraries/schema/Pdf_Relation_Schema.class.php b/libraries/schema/Pdf_Relation_Schema.class.php
index 6fd1976..a4d1260 100644
--- a/libraries/schema/Pdf_Relation_Schema.class.php
+++ b/libraries/schema/Pdf_Relation_Schema.class.php
@@ -71,12 +71,17 @@ class PMA_PDF extends TCPDF
         parent::_putpages();
     }
 
-    // added because tcpdf for PHP 5 has a protected $buffer
+    /**
+     * Getter for protected buffer.
+     */
     public function getBuffer()
     {
         return $this->buffer;
     }
 
+    /**
+     * Getter for protected state.
+     */
     public function getState()
     {
         return $this->state;
@@ -230,9 +235,11 @@ class PMA_PDF extends TCPDF
         }
     }
 
+    /**
+     * This function must be named "Footer" to work with the TCPDF library
+     */
     function Footer()
     {
-        // This function must be named "Footer" to work with the TCPDF library
         global $with_doc;
         if ($with_doc) {
             $this->SetY(-15);
@@ -243,9 +250,11 @@ class PMA_PDF extends TCPDF
         }
     }
 
+    /**
+     * Add a bookmark
+     */
     function Bookmark($txt, $level = 0, $y = 0, $page = '')
     {
-        // Add a bookmark
         $this->Outlines[0][] = $level;
         $this->Outlines[1][] = $txt;
         $this->Outlines[2][] = $this->page;
@@ -379,9 +388,11 @@ class PMA_PDF extends TCPDF
         $this->Ln($h);
     }
 
+    /**
+     * Compute number of lines used by a multicell of width w
+     */
     function NbLines($w, $txt)
     {
-        // compute number of lines used by a multicell of width w
         $cw = &$this->CurrentFont['cw'];
         if ($w == 0) {
             $w = $this->w - $this->rMargin - $this->x;


hooks/post-receive
-- 
phpMyAdmin