[phpwiki-checkins] SF.net SVN: phpwiki:[9190] trunk/lib

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

Revision: 9190
          http://sourceforge.net/p/phpwiki/code/9190
Author:   vargenau
Date:     2014-10-06 09:25:36 +0000 (Mon, 06 Oct 2014)
Log Message:
-----------
Update PHP Doc

Modified Paths:
--------------
    trunk/lib/WikiPlugin.php
    trunk/lib/WikiPluginCached.php

Modified: trunk/lib/WikiPlugin.php
===================================================================
--- trunk/lib/WikiPlugin.php	2014-10-06 08:55:30 UTC (rev 9189)
+++ trunk/lib/WikiPlugin.php	2014-10-06 09:25:36 UTC (rev 9190)
@@ -32,7 +32,13 @@
         return false;
     }
 
-    // FIXME: args?
+    /**
+     * @param WikiDB $dbi
+     * @param string $argstr
+     * @param WikiRequest $request
+     * @param string $basepage
+     * @return mixed
+     */
     function run($dbi, $argstr, &$request, $basepage)
     {
         trigger_error("WikiPlugin::run: pure virtual function", E_USER_ERROR);
@@ -371,16 +377,25 @@
     }
 
     // box is used to display a fixed-width, narrow version with common header
-    function box($args = false, $request = false, $basepage = false)
+    /**
+     * @param string $args
+     * @param WikiRequest $request
+     * @param string $basepage
+     * @return $this|HtmlElement
+     */
+    function box($args = '', $request = null, $basepage = '')
     {
-        if (!$request) $request =& $GLOBALS['request'];
-        $dbi = $request->getDbh();
+        if (!$request) {
+            $request =& $GLOBALS['request'];
+        } $dbi = $request->getDbh();
         return $this->makeBox('', $this->run($dbi, $args, $request, $basepage));
     }
 
     function makeBox($title, $body)
     {
-        if (!$title) $title = $this->getName();
+        if (!$title) {
+            $title = $this->getName();
+        }
         return HTML::div(array('class' => 'box'),
             HTML::div(array('class' => 'box-title'), $title),
             HTML::div(array('class' => 'box-data'), $body));
@@ -538,7 +553,6 @@
         $ErrorManager->pushErrorHandler(new WikiMethodCb($this, '_plugin_error_filter'));
         $plugin_class = "WikiPlugin_$plugin_name";
         if (!class_exists($plugin_class)) {
-            // $include_failed = !@include_once("lib/plugin/$plugin_name.php");
             $include_failed = !include_once($plugin_source);
             $ErrorManager->popErrorHandler();
 

Modified: trunk/lib/WikiPluginCached.php
===================================================================
--- trunk/lib/WikiPluginCached.php	2014-10-06 08:55:30 UTC (rev 9189)
+++ trunk/lib/WikiPluginCached.php	2014-10-06 09:25:36 UTC (rev 9190)
@@ -126,7 +126,7 @@
      *
      * @param  WikiDB  $dbi      database abstraction class
      * @param  string  $argstr   plugin arguments in the call from PhpWiki
-     * @param  Request $request
+     * @param  WikiRequest $request
      * @param  string  $basepage Pagename to use to interpret links [/relative] page names.
      * @return string            HTML output to be printed to browser
      *

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