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

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

Revision: 8972
          http://sourceforge.net/p/phpwiki/code/8972
Author:   vargenau
Date:     2014-07-17 12:26:03 +0000 (Thu, 17 Jul 2014)
Log Message:
-----------
Update PHP Doc

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

Modified: trunk/lib/WikiDB/backend.php
===================================================================
--- trunk/lib/WikiDB/backend.php	2014-07-17 09:33:21 UTC (rev 8971)
+++ trunk/lib/WikiDB/backend.php	2014-07-17 12:26:03 UTC (rev 8972)
@@ -292,12 +292,18 @@
     /**
      * Find pages which link to or are linked from a page.
      *
-     * @param $pagename string Page name.
-     * @param $reversed boolean True to get backlinks.
+     * @param string    $pagename  Page name.
+     * @param bool      $reversed True to get backlinks.
+     * @param bool      $include_empty
+     * @param string    $sortby
+     * @param string    $limit
+     * @param string    $exclude
+     * @param bool      $want_relations
      *
      * FIXME: array or iterator?
      * @return object A WikiDB_backend_iterator.
      */
+
     function get_links($pagename, $reversed, $include_empty = false,
                        $sortby = '', $limit = '', $exclude = '')
     {
@@ -325,7 +331,7 @@
      *
      * @access protected
      *
-     * @param $include_defaulted boolean
+     * @param bool $include_defaulted
      * If set, even pages with no content will be returned
      * --- but still only if they have at least one revision (not
      * counting the default revision 0) entered in the database.
@@ -334,6 +340,9 @@
      * are not returned as these pages are considered to be
      * non-existing.
      *
+     * @param bool $orderby
+     * @param string $limit
+     * @param string $exclude
      * @return object A WikiDB_backend_iterator.
      */
     function get_all_pages($include_defaulted, $orderby = false, $limit = '', $exclude = '')
@@ -345,16 +354,20 @@
      * Title or full text search.
      *
      * Pages should be returned in alphabetical order if that is
-     * feasable.
+     * feasible.
      *
      * @access protected
      *
-     * @param $search object A TextSearchQuery object describing the parsed query string,
+     * @param object $search object A TextSearchQuery object describing the parsed query string,
      *                       with efficient methods for SQL and PCRE match.
      *
-     * @param $fullsearch boolean If true, a full text search is performed,
+     * @param bool $fulltext If true, a full text search is performed,
      *  otherwise a title search is performed.
      *
+     * @param string $sortby
+     * @param string $limit
+     * @param string $exclude
+     *
      * @return object A WikiDB_backend_iterator.
      *
      * @see WikiDB::titleSearch
@@ -378,12 +391,12 @@
     /**
      *
      * @access protected
-     * @param $pages     object A TextSearchQuery object.
-     * @param $linkvalue object A TextSearchQuery object for the linkvalues
+     * @param object $pages      A TextSearchQuery object.
+     * @param object $linkvalue  A TextSearchQuery object for the link values
      *                          (linkto, relation or backlinks or attribute values).
-     * @param $linktype  string One of the 4 linktypes.
-     * @param $relation  object A TextSearchQuery object or false.
-     * @param $options   array Currently ignored. hash of sortby, limit, exclude.
+     * @param string $linktype   One of the 4 link types.
+     * @param object|bool $relation   A TextSearchQuery object or false.
+     * @param array $options    Currently ignored. hash of sortby, limit, exclude.
      * @return object A WikiDB_backend_iterator.
      * @see WikiDB::linkSearch
      */
@@ -401,7 +414,8 @@
      * be returned in reverse order by hit count.
      *
      * @access protected
-     * @param  integer $limit No more than this many pages
+     * @param  int $limit No more than this many pages
+     * @param  string $sortby
      * @return object  A WikiDB_backend_iterator.
      */
     function most_popular($limit, $sortby = '-hits')
@@ -421,7 +435,7 @@
      * Find recent changes.
      *
      * @access protected
-     * @param $params hash See WikiDB::mostRecent for a description
+     * @param object $params hash See WikiDB::mostRecent for a description
      *  of parameters which can be included in this hash.
      * @return object A WikiDB_backend_iterator.
      * @see WikiDB::mostRecent
@@ -505,6 +519,7 @@
      *   trigger_error("Message goes here.", E_USER_WARNING);
      * </pre>
      *
+     * @param bool $args
      * @return boolean True iff database is in a consistent state.
      */
     function check($args = false)
@@ -518,6 +533,7 @@
      * This should put the database into a consistent state.
      * (I.e. rebuild indexes, etc...)
      *
+     * @param bool $args
      * @return boolean True iff successful.
      */
     function rebuild($args = false)
@@ -671,7 +687,6 @@
 
     function write_accesslog(&$entry)
     {
-        global $request;
         if (!$this->isSQL()) return;
         $dbh = &$this->_dbh;
         $log_tbl = $entry->_accesslog->logtable;
@@ -865,6 +880,7 @@
     {
         // force word-style %word% for fulltext search
         $dbh = &$this->_dbh;
+        $word = strtolower($node->word);
         $word = '%' . $dbh->escapeSimple($word) . '%';
         // eliminate stoplist words
         if ($this->isStoplisted($node)) {

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