clean up skeletons

They should now adhere closer to the coding standard
dokuwiki · Sep 2, 2023 · 8673a04 · 8673a04
1 parent abd1c9c
commit 8673a04
Show file tree

Hide file tree

Showing 9 changed files with 44 additions and 37 deletions.
diff --git a/skel/action.php b/skel/action.php
@@ -1,19 +1,22 @@
 <?php
+
+use dokuwiki\Extension\ActionPlugin;
+use dokuwiki\Extension\EventHandler;
+use dokuwiki\Extension\Event;
+
 /**
  * DokuWiki Plugin @@PLUGIN_NAME@@ (Action Component)
  *
  * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
- * @author  @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>
+ * @author @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>
  */
-class @@PLUGIN_COMPONENT_NAME@@ extends \dokuwiki\Extension\ActionPlugin
+class @@PLUGIN_COMPONENT_NAME@@ extends ActionPlugin
 {
-
     /** @inheritDoc */
-    public function register(Doku_Event_Handler $controller)
+    public function register(EventHandler $controller)
     {
 @@REGISTER@@
     }
 
 @@HANDLERS@@
 }
-
diff --git a/skel/action_handler.php b/skel/action_handler.php
@@ -3,10 +3,10 @@
      * Event handler for @@EVENT@@
      *
      * @see https://www.dokuwiki.org/devel:events:@@EVENT@@
-     * @param Doku_Event $event Event object
+     * @param Event $event Event object
      * @param mixed $param optional parameter passed when event was registered
      * @return void
      */
-    public function @@HANDLER@@(Doku_Event $event, $param) {
-
+    public function @@HANDLER@@(Event $event, $param)
+    {
     }
diff --git a/skel/admin.php b/skel/admin.php
@@ -1,13 +1,15 @@
 <?php
+
+use dokuwiki\Extension\AdminPlugin;
+
 /**
  * DokuWiki Plugin @@PLUGIN_NAME@@ (Admin Component)
  *
  * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
- * @author  @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>
+ * @author @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>
  */
-class @@PLUGIN_COMPONENT_NAME@@ extends \dokuwiki\Extension\AdminPlugin
+class @@PLUGIN_COMPONENT_NAME@@ extends AdminPlugin
 {
-
     /** @inheritDoc */
     public function handle()
     {
@@ -21,4 +23,3 @@ public function html()
         echo '<h1>' . $this->getLang('menu') . '</h1>';
     }
 }
-
diff --git a/skel/auth.php b/skel/auth.php
@@ -1,13 +1,15 @@
 <?php
+
+use dokuwiki\Extension\AuthPlugin;
+
 /**
  * DokuWiki Plugin @@PLUGIN_NAME@@ (Auth Component)
  *
  * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
- * @author  @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>
+ * @author @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>
  */
-class @@PLUGIN_COMPONENT_NAME@@ extends \dokuwiki\Extension\AuthPlugin
+class @@PLUGIN_COMPONENT_NAME@@ extends AuthPlugin
 {
-
     /** @inheritDoc */
     public function __construct()
     {
@@ -31,7 +33,6 @@ public function __construct()
         $this->success = true;
     }
 
-
     /** @inheritDoc */
     // public function logOff()
     // {
@@ -69,7 +70,7 @@ public function checkPass($user, $pass)
     }
 
     /** @inheritDoc */
-    public function getUserData($user, $requireGroups=true)
+    public function getUserData($user, $requireGroups = true)
     {
         /*
         FIXME implement and return something like this
@@ -156,4 +157,3 @@ public function cleanGroup($group)
       // FIXME implement
     //}
 }
-
diff --git a/skel/helper.php b/skel/helper.php
@@ -1,12 +1,13 @@
 <?php
+
+use dokuwiki\Extension\Plugin;
+
 /**
  * DokuWiki Plugin @@PLUGIN_NAME@@ (Helper Component)
  *
  * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
- * @author  @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>
+ * @author @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>
  */
-class @@PLUGIN_COMPONENT_NAME@@ extends \dokuwiki\Extension\Plugin
+class @@PLUGIN_COMPONENT_NAME@@ extends Plugin
 {
-
 }
-
diff --git a/skel/remote.php b/skel/remote.php
@@ -1,13 +1,16 @@
 <?php
+
+use dokuwiki\Extension\RemotePlugin;
+use dokuwiki\Remote\AccessDeniedException;
+
 /**
  * DokuWiki Plugin @@PLUGIN_NAME@@ (Action Component)
  *
  * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
- * @author  @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>
+ * @author @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>
  */
-class @@PLUGIN_COMPONENT_NAME@@ extends \dokuwiki\Extension\RemotePlugin
+class @@PLUGIN_COMPONENT_NAME@@ extends RemotePlugin
 {
-
     /**
      * Example function
      *
@@ -18,10 +21,9 @@ public function myExample($id)
         // FIXME handle security in your method!
         $id = cleanID($id);
         if (auth_quickaclcheck($id) < AUTH_READ) {
-            throw new RemoteAccessDeniedException('You are not allowed to read this file', 111);
+            throw new AccessDeniedException('You are not allowed to read this file', 111);
         }
 
         return 'example';
     }
 }
-
diff --git a/skel/renderer.php b/skel/renderer.php
@@ -1,13 +1,13 @@
 <?php
+
 /**
  * DokuWiki Plugin @@PLUGIN_NAME@@ (Renderer Component)
  *
  * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
- * @author  @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>
+ * @author @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>
  */
 class @@PLUGIN_COMPONENT_NAME@@ extends Doku_Renderer
 {
-
     /** @inheritDoc */
     public function getFormat()
     {
@@ -16,4 +16,3 @@ public function getFormat()
 
     // FIXME implement all methods of Doku_Renderer here
 }
-
diff --git a/skel/renderer_xhtml.php b/skel/renderer_xhtml.php
@@ -1,13 +1,13 @@
 <?php
+
 /**
  * DokuWiki Plugin @@PLUGIN_NAME@@ (Renderer Component)
  *
  * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
- * @author  @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>
+ * @author @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>
  */
 class @@PLUGIN_COMPONENT_NAME@@ extends Doku_Renderer_xhtml
 {
-
     /**
      * @inheritDoc
      * Make available as XHTML replacement renderer
@@ -22,4 +22,3 @@ public function canRender($format)
 
     // FIXME override any methods of Doku_Renderer_xhtml here
 }
-
diff --git a/skel/syntax.php b/skel/syntax.php
@@ -1,11 +1,14 @@
 <?php
+
+use dokuwiki\Extension\SyntaxPlugin;
+
 /**
  * DokuWiki Plugin @@PLUGIN_NAME@@ (Syntax Component)
  *
  * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
- * @author  @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>
+ * @author @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>
  */
-class @@PLUGIN_COMPONENT_NAME@@ extends \dokuwiki\Extension\SyntaxPlugin
+class @@PLUGIN_COMPONENT_NAME@@ extends SyntaxPlugin
 {
     /** @inheritDoc */
     public function getType()
@@ -41,7 +44,7 @@ public function connectTo($mode)
     /** @inheritDoc */
     public function handle($match, $state, $pos, Doku_Handler $handler)
     {
-        $data = array();
+        $data = [];
 
         return $data;
     }
@@ -56,4 +59,3 @@ public function render($mode, Doku_Renderer $renderer, $data)
         return true;
     }
 }
-