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

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

Revision: 9595
          http://sourceforge.net/p/phpwiki/code/9595
Author:   vargenau
Date:     2015-03-04 13:51:29 +0000 (Wed, 04 Mar 2015)
Log Message:
-----------
PHP Doc

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

Modified: trunk/lib/WikiDB/backend/dbaBase.php
===================================================================
--- trunk/lib/WikiDB/backend/dbaBase.php	2015-03-04 13:28:25 UTC (rev 9594)
+++ trunk/lib/WikiDB/backend/dbaBase.php	2015-03-04 13:51:29 UTC (rev 9595)
@@ -179,7 +179,16 @@
         return false;
     }
 
-    //check $want_content
+    /**
+     * 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)
     {
         $data = $this->_versiondb->get((int)$version . ":$pagename");
@@ -196,7 +205,7 @@
         }
     }
 
-    /**
+    /*
      * Can be undone and is seen in RecentChanges.
      * See backend.php
      */
@@ -225,7 +234,7 @@
         $this->set_links($pagename, array());
     }
 
-    /**
+    /*
      * Completely delete all page revisions from the database.
      */
     function purge_page($pagename)
@@ -277,7 +286,7 @@
         return true;
     }
 
-    /**
+    /*
      * Delete an old revision of a page.
      */
     function delete_versiondata($pagename, $version)
@@ -302,7 +311,7 @@
         }
     }
 
-    /**
+    /*
      * Create a new revision of a page.
      */
     function set_versiondata($pagename, $version, $data)
@@ -416,7 +425,7 @@
             ));
     }
 
-    /**
+    /*
      * @return array of all linkrelations
      * Faster than the dumb WikiDB method.
      */
@@ -460,14 +469,14 @@
      * the link key, we iterate here directly over the
      * linkdb and check the pagematch there.
      *
-     * @param $pages     object A TextSearchQuery object for the pagename filter.
-     * @param $query     object A SearchQuery object (Text or Numeric) for the linkvalues,
+     * @param object$pages      A TextSearchQuery object for the pagename filter.
+     * @param object $query     A SearchQuery object (Text or Numeric) for the linkvalues,
      *                          linkto, linkfrom (=backlink), relation or attribute values.
-     * @param $linktype  string One of the 4 linktypes "linkto",
+     * @param string $linktype  One of the 4 linktypes "linkto",
      *                          "linkfrom" (=backlink), "relation" or "attribute".
      *                 Maybe also "relation+attribute" for the advanced search.
-     * @param $relation  object A TextSearchQuery for the linkname or false.
-     * @param $options   array Currently ignored. hash of sortby, limit, exclude.
+     * @param bool|object $relation   A TextSearchQuery for the linkname or false.
+     * @param array $options    Currently ignored. hash of sortby, limit, exclude.
      * @return object A WikiDB_backend_iterator.
      * @see WikiDB::linkSearch
      */

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