[phpwiki-checkins] SF.net SVN: phpwiki:[9609] trunk/lib/WikiDB/backend/PearDB_ffpgsql.php

[<var...@us...>]

Revision: 9609
          http://sourceforge.net/p/phpwiki/code/9609
Author:   vargenau
Date:     2015-03-05 18:30:15 +0000 (Thu, 05 Mar 2015)
Log Message:
-----------
Add comments

Modified Paths:
--------------
    trunk/lib/WikiDB/backend/PearDB_ffpgsql.php

Modified: trunk/lib/WikiDB/backend/PearDB_ffpgsql.php
===================================================================
--- trunk/lib/WikiDB/backend/PearDB_ffpgsql.php	2015-03-05 18:06:57 UTC (rev 9608)
+++ trunk/lib/WikiDB/backend/PearDB_ffpgsql.php	2015-03-05 18:30:15 UTC (rev 9609)
@@ -75,6 +75,9 @@
             . " AND substring($page_tbl.pagename from 0 for $p) = '$pat'");
     }
 
+    /*
+     * filter (nonempty pages) currently ignored
+     */
     function numPages($filter = false, $exclude = '')
     {
         $dbh = &$this->_dbh;
@@ -88,6 +91,9 @@
             . " AND substring($page_tbl.pagename from 0 for $p) = '$pat'");
     }
 
+    /*
+     * Read page information from database.
+     */
     function get_pagedata($pagename)
     {
         global $page_prefix;
@@ -165,6 +171,16 @@
         return parent::get_previous_version($page_prefix . $pagename, $version);
     }
 
+    /**
+     * Get version data.
+     *
+     * @param string $pagename Name of the page
+     * @param int $version Which version to get
+     * @param bool $want_content Do we need content?
+     *
+     * @return array hash The version data, or false if specified version does not
+     *              exist.
+     */
     function get_versiondata($pagename, $version, $want_content = false)
     {
         $dbh = &$this->_dbh;
@@ -174,11 +190,10 @@
         // assert(is_string($pagename) and $pagename != "");
         // assert($version > 0);
 
-        //trigger_error("GET_REVISION $pagename $version $want_content", E_USER_NOTICE);
         // FIXME: optimization: sometimes don't get page data?
         if ($want_content) {
             $fields = $this->page_tbl_fields
-                . ",$page_tbl.pagedata as pagedata,"
+                . ",$page_tbl.pagedata AS pagedata,"
                 . $this->version_tbl_fields;
         } else {
             $fields = $this->page_tbl_fields . ","
@@ -253,6 +268,9 @@
         return $id;
     }
 
+    /*
+     * Delete page completely from the database.
+     */
     function purge_page($pagename)
     {
         $dbh = &$this->_dbh;
@@ -281,6 +299,13 @@
         return $result;
     }
 
+    /*
+     * Find pages which link to or are linked from a page.
+     *
+     * TESTME relations: get_links is responsible to add the relation to the pagehash
+     * as 'linkrelation' key as pagename. See WikiDB_PageIterator::next
+     *   if (isset($next['linkrelation']))
+     */
     function get_links($pagename, $reversed = true, $include_empty = false,
                        $sortby = '', $limit = '', $exclude = '',
                        $want_relations = false)
@@ -399,6 +424,9 @@
         return new WikiDB_backend_PearDB_iter($this, $result, $options);
     }
 
+    /*
+     * Find highest or lowest hit counts.
+     */
     public function most_popular($limit = 20, $sortby = '-hits')
     {
         $dbh = &$this->_dbh;
@@ -435,10 +463,12 @@
         } else {
             $result = $dbh->query($sql);
         }
-
         return new WikiDB_backend_PearDB_iter($this, $result);
     }
 
+    /*
+     * Find recent changes.
+     */
     public function most_recent($params)
     {
         $limit = 0;
@@ -514,6 +544,9 @@
         return new WikiDB_backend_PearDB_iter($this, $result);
     }
 
+    /*
+     * Find referenced empty pages.
+     */
     function wanted_pages($exclude_from = '', $exclude = '', $sortby = '', $limit = '')
     {
         $dbh = &$this->_dbh;
@@ -528,7 +561,6 @@
             $exclude_from = " AND pp.pagename NOT IN " . $this->_sql_set($exclude_from);
         if ($exclude) // array of pagenames
             $exclude = " AND p.pagename NOT IN " . $this->_sql_set($exclude);
-
         $p = strlen($page_prefix) + 1;
         $sql = "SELECT substring(p.pagename from $p) AS wantedfrom, substring(pp.pagename from $p) AS pagename"
             . " FROM $page_tbl p, $link_tbl linked"

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.