remove requires, if defined DOKU_INC, add phpdocs,

remove some by ref of objects, some formatting

Author: Klap-in

action.php

@@ -4,16 +4,11 @@
  * @author     Esther Brunner <[email protected]>
  */
 
-// must be run within Dokuwiki
-if(!defined('DOKU_INC')) die();
-
-if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
-require_once(DOKU_PLUGIN.'action.php');
-
 class action_plugin_blog extends DokuWiki_Action_Plugin {
 
     /**
      * register the eventhandlers
+     * @param Doku_Event_Handler $contr
      */
     function register(Doku_Event_Handler $contr) {
         $contr->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'handle_act_preprocess', array());
@@ -24,6 +19,8 @@ function register(Doku_Event_Handler $contr) {
     /**
      * Checks if 'newentry' was given as action, if so we
      * do handle the event our self and no further checking takes place
+     * @param Doku_Event $event
+     * @param $param
      */
     function handle_act_preprocess(Doku_Event $event, $param) {
         if ($event->data != 'newentry') return; // nothing to do for us
@@ -34,9 +31,12 @@ function handle_act_preprocess(Doku_Event $event, $param) {
     /**
      * Removes draft entries from feeds
      *
+     * @param Doku_Event $event
+     * @param $param
+     *
      * @author Michael Klier <[email protected]>
      */
-    function handle_feed_item(&$event, $param) {
+    function handle_feed_item(Doku_Event $event, $param) {
         global $conf;
 
         $url = parse_url($event->data['item']->link);
@@ -80,6 +80,9 @@ function handle_feed_item(&$event, $param) {
 
     /**
      * Creates a new entry page
+     *
+     * @param Doku_Event $event
+     * @return string
      */
     function _handle_newEntry(Doku_Event $event) {
         global $ID, $INFO;
@@ -123,6 +126,10 @@ function _handle_newEntry(Doku_Event $event) {
 
     /**
      * Adapted version of pageTemplate() function
+     *
+     * @param $text
+     * @param $data
+     * @return string|string[]
      */
     function _pageTemplate($text, $data) {
         global $conf, $INFO;
@@ -175,8 +182,12 @@ function _pageTemplate($text, $data) {
     /**
      * Returns the ID of a new entry based on its namespace, title and the date prefix
      *
-     * @author  Esther Brunner <[email protected]>
+     * @param $ns
+     * @param $title
+     * @return mixed|string|string[]|null
+     *
      * @author  Michael Arlt <[email protected]>
+     * @author  Esther Brunner <[email protected]>
      */
     function _newEntryID($ns, $title) {
         $dateprefix  = $this->getConf('dateprefix');
@@ -205,6 +216,9 @@ function _newEntryID($ns, $title) {
     /**
      * Expire the renderer cache of archive pages whenever a page is updated or a comment or linkback is added
      *
+     * @param Doku_Event $event
+     * @param $params
+     *
      * @author Michael Hamann <[email protected]>
      */
     function handle_cache(Doku_Event $event, $params) {
@@ -243,4 +257,3 @@ function handle_cache(Doku_Event $event, $params) {
         }
     }
 }
-// vim:ts=4:sw=4:et:enc=utf-8:

helper.php

@@ -4,9 +4,6 @@
  * @author     Esther Brunner <[email protected]>
  */
 
-// must be run within Dokuwiki
-if (!defined('DOKU_INC')) die();
-
 class helper_plugin_blog extends DokuWiki_Plugin {
 
     var $sort       = '';      // sort key
@@ -15,8 +12,6 @@ class helper_plugin_blog extends DokuWiki_Plugin {
      * Constructor
      */
     function helper_plugin_blog() {
-        global $conf;
-
         // load sort key from settings
         $this->sort = $this->getConf('sortkey');
     }
@@ -42,16 +37,17 @@ function getMethods() {
 
     /**
      * Get blog entries from a given namespace
+     *
+     * @param $ns
+     * @param null $num
+     * @param null $author
+     * @return array
      */
     function getBlog($ns, $num = NULL, $author = NULL) {
-        global $conf;
-
         // add pages in given namespace
         $result  = array();
         global $conf;
 
-        require_once (DOKU_INC.'inc/search.php');
-
         $pages = array();
         $unique_keys_memoize = array();
 
@@ -172,6 +168,10 @@ function getFlags($setflags) {
     /**
      * Function to create sortable, unique array keys
      *
+     * @param $key
+     * @param $unique_keys_memoize
+     * @return string
+     *
      * @author    Esther Brunner <[email protected]>
      * @author    Ilya S. Lebedev <[email protected]>
      * @author    Balazs Attila-Mihaly <[email protected]>
@@ -187,4 +187,3 @@ function _uniqueKey($key, &$unique_keys_memoize){
     }
 
 }
-// vim:ts=4:sw=4:et:enc=utf-8:

plugin.info.txt

@@ -2,7 +2,7 @@
 base   blog
 author Michael Hamann, Michael Klier, Gina Haeussge
 email  [email protected]
-date   2018-09-03
+date   2020-09-18
 name   Blog
 desc   Use DokuWiki as blogging tool. (previous authors: Esther Brunner)
-url    http://www.dokuwiki.org/plugin:blog
+url    https://www.dokuwiki.org/plugin:blog

syntax/archive.php

@@ -6,12 +6,6 @@
  * @author   Esther Brunner <[email protected]>
  */
 
-// must be run within Dokuwiki
-if(!defined('DOKU_INC')) die();
-
-if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
-require_once(DOKU_PLUGIN.'syntax.php');
-
 /**
  * All DokuWiki plugins to extend the parser/rendering mechanism
  * need to inherit from this class
@@ -100,7 +94,7 @@ function render($mode, Doku_Renderer $renderer, $data) {
 
         // get the blog entries for our namespace
         /** @var helper_plugin_blog $my */
-        if ($my =& plugin_load('helper', 'blog')) $entries = $my->getBlog($ns, NULL, $author);
+        if ($my = plugin_load('helper', 'blog')) $entries = $my->getBlog($ns, NULL, $author);
         else return false;
 
         // use tag refinements?
@@ -127,7 +121,7 @@ function render($mode, Doku_Renderer $renderer, $data) {
             } else {
                 // let Pagelist Plugin do the work for us
                 if (plugin_isdisabled('pagelist')
-                        || (!$pagelist =& plugin_load('helper', 'pagelist'))) {
+                        || (!$pagelist = plugin_load('helper', 'pagelist'))) {
                     msg($this->getLang('missing_pagelistplugin'), -1);
                     return false;
                 }

syntax/autoarchive.php

@@ -1,17 +1,11 @@
 <?php
 /**
- * Dynamic Archive Plugin: dynamically displays 
+ * Dynamic Archive Plugin: dynamically displays
  *
  * @license  GPL 2 (http://www.gnu.org/licenses/gpl.html)
  * @author   Esther Brunner <[email protected]>
  */
 
-// must be run within Dokuwiki
-if(!defined('DOKU_INC')) die();
-
-if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
-require_once(DOKU_PLUGIN.'syntax.php');
-
 /**
  * All DokuWiki plugins to extend the parser/rendering mechanism
  * need to inherit from this class
@@ -50,7 +44,7 @@ function render($mode, Doku_Renderer $renderer, $data) {
         $renderer->info['cache'] = false;
 
         // get the blog entries for our namespace
-        if ($my =& plugin_load('helper', 'blog')) $entries = $my->getBlog($ns);
+        if ($my = plugin_load('helper', 'blog')) $entries = $my->getBlog($ns);
 
         // use tag refinements?
         if ($refine) {
@@ -79,7 +73,7 @@ function render($mode, Doku_Renderer $renderer, $data) {
 
         // let Pagelist Plugin do the work for us
         if (plugin_isdisabled('pagelist')
-                || (!$pagelist =& plugin_load('helper', 'pagelist'))) {
+                || (!$pagelist = plugin_load('helper', 'pagelist'))) {
             msg($this->getLang('missing_pagelistplugin'), -1);
             return false;
         }

syntax/blog.php

@@ -7,15 +7,6 @@
  * @author   Robert Rackl <[email protected]>
  */
 
-// must be run within Dokuwiki
-if (!defined('DOKU_INC')) die();
-
-if (!defined('DOKU_LF')) define('DOKU_LF', "\n");
-if (!defined('DOKU_TAB')) define('DOKU_TAB', "\t");
-if (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN', DOKU_INC.'lib/plugins/');
-
-require_once(DOKU_PLUGIN.'syntax.php');
-
 class syntax_plugin_blog_blog extends DokuWiki_Syntax_Plugin {
     private $included_pages = array();
 
@@ -62,13 +53,13 @@ function render($mode, Doku_Renderer $renderer, $data) {
 
         // get the blog entries for our namespace
         /** @var helper_plugin_blog $my */
-        if ($my =& plugin_load('helper', 'blog')) $entries = $my->getBlog($ns);
+        if ($my = plugin_load('helper', 'blog')) $entries = $my->getBlog($ns);
         else return false;
 
         // use tag refinements?
         if ($refine) {
             /** @var helper_plugin_tag $tag */
-            if (plugin_isdisabled('tag') || (!$tag =& plugin_load('helper', 'tag'))) {
+            if (plugin_isdisabled('tag') || (!$tag = plugin_load('helper', 'tag'))) {
                 msg($this->getLang('missing_tagplugin'), -1);
             } else {
                 $entries = $tag->tagRefine($entries, $refine);
@@ -94,12 +85,12 @@ function render($mode, Doku_Renderer $renderer, $data) {
         }
 
         // slice the needed chunk of pages
-        $more = ((count($entries) > ($first + $num)) ? true : false);
+        $isMore = count($entries) > ($first + $num);
         $entries = array_slice($entries, $first, $num);
 
         // load the include helper plugin
         /** @var helper_plugin_include $include */
-        if (plugin_isdisabled('include') || (!$include =& plugin_load('helper', 'include'))) {
+        if (plugin_isdisabled('include') || (!$include = plugin_load('helper', 'include'))) {
             msg($this->getLang('missing_includeplugin'), -1);
             return false;
         }
@@ -150,7 +141,7 @@ function render($mode, Doku_Renderer $renderer, $data) {
             if ($clevel && !$include_flags['inline']) $renderer->doc .= '<div class="level'.$clevel.'">'.DOKU_LF;
 
             // show older / newer entries links
-            if ($pagingcontrols) $renderer->doc .= $this->_browseEntriesLinks($more, $first, $num);
+            if ($pagingcontrols) $renderer->doc .= $this->_browseEntriesLinks($isMore, $first, $num);
 
             // show new entry form
             if ($perm_create && $formpos == 'bottom') {
@@ -165,6 +156,11 @@ function render($mode, Doku_Renderer $renderer, $data) {
 
     /**
      * Displays links to older newer entries of the blog namespace
+     *
+     * @param $more
+     * @param $first
+     * @param $num
+     * @return string
      */
     function _browseEntriesLinks($more, $first, $num) {
         global $ID;
@@ -191,6 +187,10 @@ function _browseEntriesLinks($more, $first, $num) {
     /**
      * Displays a form to enter the title of a new entry in the blog namespace
      * and then open that page in the edit mode
+     *
+     * @param $ns
+     * @param $newentrytitle
+     * @return string
      */
     function _newEntryForm($ns, $newentrytitle) {
         global $lang;

syntax/draft.php

@@ -1,17 +1,11 @@
 <?php
 /**
  * Blog Plugin, draft component: marks the current page as draft
- * 
+ *
  * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
  * @author     Esther Brunner <[email protected]>
  */
 
-// must be run within Dokuwiki
-if (!defined('DOKU_INC')) die();
-
-if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
-require_once(DOKU_PLUGIN.'syntax.php');
-
 class syntax_plugin_blog_draft extends DokuWiki_Syntax_Plugin {
 
     function getType() { return 'substition'; }