clean up skeletons

splitbrain · splitbrain · commit 8673a04e3e6f · 2023-09-02T19:32:15.000+02:00
They should now adhere closer to the coding standard
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;
     }
 }
-

Original file line number	Diff line number	Diff line change
`@@ -1,19 +1,22 @@`
`1`	`1`	`<?php`
	`2`	`+`
	`3`	`+use dokuwiki\Extension\ActionPlugin;`
	`4`	`+use dokuwiki\Extension\EventHandler;`
	`5`	`+use dokuwiki\Extension\Event;`
	`6`	`+`
`2`	`7`	`/**`
`3`	`8`	`* DokuWiki Plugin @@PLUGIN_NAME@@ (Action Component)`
`4`	`9`	`*`
`5`	`10`	`* @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html`
`6`		`- * @author @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>`
	`11`	`+ * @author @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>`
`7`	`12`	`*/`
`8`		`-class @@PLUGIN_COMPONENT_NAME@@ extends \dokuwiki\Extension\ActionPlugin`
	`13`	`+class @@PLUGIN_COMPONENT_NAME@@ extends ActionPlugin`
`9`	`14`	`{`
`10`		`-`
`11`	`15`	`/** @inheritDoc */`
`12`		`- public function register(Doku_Event_Handler $controller)`
	`16`	`+ public function register(EventHandler $controller)`
`13`	`17`	`{`
`14`	`18`	`@@REGISTER@@`
`15`	`19`	`}`
`16`	`20`
`17`	`21`	`@@HANDLERS@@`
`18`	`22`	`}`
`19`		`-`
Original file line number	Diff line number	Diff line change
`@@ -3,10 +3,10 @@`
`3`	`3`	`* Event handler for @@EVENT@@`
`4`	`4`	`*`
`5`	`5`	`* @see https://www.dokuwiki.org/devel:events:@@EVENT@@`
`6`		`- * @param Doku_Event $event Event object`
	`6`	`+ * @param Event $event Event object`
`7`	`7`	`* @param mixed $param optional parameter passed when event was registered`
`8`	`8`	`* @return void`
`9`	`9`	`*/`
`10`		`- public function @@HANDLER@@(Doku_Event $event, $param) {`
`11`		`-`
	`10`	`+ public function @@HANDLER@@(Event $event, $param)`
	`11`	`+ {`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,15 @@`
`1`	`1`	`<?php`
	`2`	`+`
	`3`	`+use dokuwiki\Extension\AdminPlugin;`
	`4`	`+`
`2`	`5`	`/**`
`3`	`6`	`* DokuWiki Plugin @@PLUGIN_NAME@@ (Admin Component)`
`4`	`7`	`*`
`5`	`8`	`* @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html`
`6`		`- * @author @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>`
	`9`	`+ * @author @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>`
`7`	`10`	`*/`
`8`		`-class @@PLUGIN_COMPONENT_NAME@@ extends \dokuwiki\Extension\AdminPlugin`
	`11`	`+class @@PLUGIN_COMPONENT_NAME@@ extends AdminPlugin`
`9`	`12`	`{`
`10`		`-`
`11`	`13`	`/** @inheritDoc */`
`12`	`14`	`public function handle()`
`13`	`15`	`{`
`@@ -21,4 +23,3 @@ public function html()`
`21`	`23`	`echo '<h1>' . $this->getLang('menu') . '</h1>';`
`22`	`24`	`}`
`23`	`25`	`}`
`24`		`-`
Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,15 @@`
`1`	`1`	`<?php`
	`2`	`+`
	`3`	`+use dokuwiki\Extension\AuthPlugin;`
	`4`	`+`
`2`	`5`	`/**`
`3`	`6`	`* DokuWiki Plugin @@PLUGIN_NAME@@ (Auth Component)`
`4`	`7`	`*`
`5`	`8`	`* @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html`
`6`		`- * @author @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>`
	`9`	`+ * @author @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>`
`7`	`10`	`*/`
`8`		`-class @@PLUGIN_COMPONENT_NAME@@ extends \dokuwiki\Extension\AuthPlugin`
	`11`	`+class @@PLUGIN_COMPONENT_NAME@@ extends AuthPlugin`
`9`	`12`	`{`
`10`		`-`
`11`	`13`	`/** @inheritDoc */`
`12`	`14`	`public function __construct()`
`13`	`15`	`{`
`@@ -31,7 +33,6 @@ public function __construct()`
`31`	`33`	`$this->success = true;`
`32`	`34`	`}`
`33`	`35`
`34`		`-`
`35`	`36`	`/** @inheritDoc */`
`36`	`37`	`// public function logOff()`
`37`	`38`	`// {`
`@@ -69,7 +70,7 @@ public function checkPass($user, $pass)`
`69`	`70`	`}`
`70`	`71`
`71`	`72`	`/** @inheritDoc */`
`72`		`- public function getUserData($user, $requireGroups=true)`
	`73`	`+ public function getUserData($user, $requireGroups = true)`
`73`	`74`	`{`
`74`	`75`	`/*`
`75`	`76`	`FIXME implement and return something like this`
`@@ -156,4 +157,3 @@ public function cleanGroup($group)`
`156`	`157`	`// FIXME implement`
`157`	`158`	`//}`
`158`	`159`	`}`
`159`		`-`
Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,13 @@`
`1`	`1`	`<?php`
	`2`	`+`
	`3`	`+use dokuwiki\Extension\Plugin;`
	`4`	`+`
`2`	`5`	`/**`
`3`	`6`	`* DokuWiki Plugin @@PLUGIN_NAME@@ (Helper Component)`
`4`	`7`	`*`
`5`	`8`	`* @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html`
`6`		`- * @author @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>`
	`9`	`+ * @author @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>`
`7`	`10`	`*/`
`8`		`-class @@PLUGIN_COMPONENT_NAME@@ extends \dokuwiki\Extension\Plugin`
	`11`	`+class @@PLUGIN_COMPONENT_NAME@@ extends Plugin`
`9`	`12`	`{`
`10`		`-`
`11`	`13`	`}`
`12`		`-`
Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,16 @@`
`1`	`1`	`<?php`
	`2`	`+`
	`3`	`+use dokuwiki\Extension\RemotePlugin;`
	`4`	`+use dokuwiki\Remote\AccessDeniedException;`
	`5`	`+`
`2`	`6`	`/**`
`3`	`7`	`* DokuWiki Plugin @@PLUGIN_NAME@@ (Action Component)`
`4`	`8`	`*`
`5`	`9`	`* @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html`
`6`		`- * @author @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>`
	`10`	`+ * @author @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>`
`7`	`11`	`*/`
`8`		`-class @@PLUGIN_COMPONENT_NAME@@ extends \dokuwiki\Extension\RemotePlugin`
	`12`	`+class @@PLUGIN_COMPONENT_NAME@@ extends RemotePlugin`
`9`	`13`	`{`
`10`		`-`
`11`	`14`	`/**`
`12`	`15`	`* Example function`
`13`	`16`	`*`
`@@ -18,10 +21,9 @@ public function myExample($id)`
`18`	`21`	`// FIXME handle security in your method!`
`19`	`22`	`$id = cleanID($id);`
`20`	`23`	`if (auth_quickaclcheck($id) < AUTH_READ) {`
`21`		`- throw new RemoteAccessDeniedException('You are not allowed to read this file', 111);`
	`24`	`+ throw new AccessDeniedException('You are not allowed to read this file', 111);`
`22`	`25`	`}`
`23`	`26`
`24`	`27`	`return 'example';`
`25`	`28`	`}`
`26`	`29`	`}`
`27`		`-`
Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,13 @@`
`1`	`1`	`<?php`
	`2`	`+`
`2`	`3`	`/**`
`3`	`4`	`* DokuWiki Plugin @@PLUGIN_NAME@@ (Renderer Component)`
`4`	`5`	`*`
`5`	`6`	`* @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html`
`6`		`- * @author @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>`
	`7`	`+ * @author @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>`
`7`	`8`	`*/`
`8`	`9`	`class @@PLUGIN_COMPONENT_NAME@@ extends Doku_Renderer`
`9`	`10`	`{`
`10`		`-`
`11`	`11`	`/** @inheritDoc */`
`12`	`12`	`public function getFormat()`
`13`	`13`	`{`
`@@ -16,4 +16,3 @@ public function getFormat()`
`16`	`16`
`17`	`17`	`// FIXME implement all methods of Doku_Renderer here`
`18`	`18`	`}`
`19`		`-`
Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,14 @@`
`1`	`1`	`<?php`
	`2`	`+`
	`3`	`+use dokuwiki\Extension\SyntaxPlugin;`
	`4`	`+`
`2`	`5`	`/**`
`3`	`6`	`* DokuWiki Plugin @@PLUGIN_NAME@@ (Syntax Component)`
`4`	`7`	`*`
`5`	`8`	`* @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html`
`6`		`- * @author @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>`
	`9`	`+ * @author @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>`
`7`	`10`	`*/`
`8`		`-class @@PLUGIN_COMPONENT_NAME@@ extends \dokuwiki\Extension\SyntaxPlugin`
	`11`	`+class @@PLUGIN_COMPONENT_NAME@@ extends SyntaxPlugin`
`9`	`12`	`{`
`10`	`13`	`/** @inheritDoc */`
`11`	`14`	`public function getType()`
`@@ -41,7 +44,7 @@ public function connectTo($mode)`
`41`	`44`	`/** @inheritDoc */`
`42`	`45`	`public function handle($match, $state, $pos, Doku_Handler $handler)`
`43`	`46`	`{`
`44`		`- $data = array();`
	`47`	`+ $data = [];`
`45`	`48`
`46`	`49`	`return $data;`
`47`	`50`	`}`
`@@ -56,4 +59,3 @@ public function render($mode, Doku_Renderer $renderer, $data)`
`56`	`59`	`return true;`
`57`	`60`	`}`
`58`	`61`	`}`
`59`		`-`