Skip to content

Commit c27979b

Browse files
anndagithub-actions[bot]
annda
authored and
github-actions[bot]
committed
🤖 Automatic code style fixes
1 parent 182b3de commit c27979b

38 files changed

+168
-149
lines changed

‎ProsemirrorException.php‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
*
1010
* @package dokuwiki\plugin\prosemirror
1111
*/
12-
class ProsemirrorException extends \RuntimeException {
12+
class ProsemirrorException extends \RuntimeException
13+
{
1314
public $data = [];
1415

1516
/**

‎action/ajax.php‎

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<?php
2+
23
/**
34
* DokuWiki Plugin prosemirror (Action Component)
45
*
@@ -7,23 +8,29 @@
78
*/
89

910
// must be run within Dokuwiki
10-
11+
use dokuwiki\Extension\ActionPlugin;
12+
use dokuwiki\Extension\EventHandler;
13+
use dokuwiki\Extension\Event;
14+
use dokuwiki\plugin\prosemirror\parser\ImageNode;
15+
use dokuwiki\plugin\prosemirror\parser\RSSNode;
16+
use dokuwiki\plugin\prosemirror\parser\LocalLinkNode;
17+
use dokuwiki\plugin\prosemirror\parser\InternalLinkNode;
1118
use dokuwiki\plugin\prosemirror\parser\LinkNode;
1219

1320
if (!defined('DOKU_INC')) {
1421
die();
1522
}
1623

17-
class action_plugin_prosemirror_ajax extends DokuWiki_Action_Plugin
24+
class action_plugin_prosemirror_ajax extends ActionPlugin
1825
{
1926
/**
2027
* Registers a callback function for a given event
2128
*
22-
* @param Doku_Event_Handler $controller DokuWiki's event controller object
29+
* @param EventHandler $controller DokuWiki's event controller object
2330
*
2431
* @return void
2532
*/
26-
public function register(Doku_Event_Handler $controller)
33+
public function register(EventHandler $controller)
2734
{
2835
$controller->register_hook('AJAX_CALL_UNKNOWN', 'BEFORE', $this, 'handleAjax');
2936
$controller->register_hook('AJAX_CALL_UNKNOWN', 'BEFORE', $this, 'switchEditors');
@@ -34,13 +41,13 @@ public function register(Doku_Event_Handler $controller)
3441
*
3542
* Event: AJAX_CALL_UNKNOWN
3643
*
37-
* @param Doku_Event $event event object by reference
44+
* @param Event $event event object by reference
3845
* @param mixed $param [the parameters passed as fifth argument to register_hook() when this
3946
* handler was registered]
4047
*
4148
* @return void
4249
*/
43-
public function handleAjax(Doku_Event $event, $param)
50+
public function handleAjax(Event $event, $param)
4451
{
4552
if ($event->data !== 'plugin_prosemirror') {
4653
return;
@@ -58,19 +65,19 @@ public function handleAjax(Doku_Event $event, $param)
5865
$inner = $INPUT->str('inner');
5966
$responseData[$action] = $this->resolveInternalLink($inner, $ID);
6067
break;
61-
}
68+
}
6269
case 'resolveInterWikiLink':
6370
{
6471
$inner = $INPUT->str('inner');
65-
list($shortcut, $reference) = explode('>', $inner);
72+
[$shortcut, $reference] = explode('>', $inner);
6673
$responseData[$action] = $this->resolveInterWikiLink($shortcut, $reference);
6774
break;
68-
}
75+
}
6976
case 'resolveMedia':
7077
{
7178
$attrs = $INPUT->arr('attrs');
7279
$responseData[$action] = [
73-
'data-resolvedHtml' => \dokuwiki\plugin\prosemirror\parser\ImageNode::resolveMedia(
80+
'data-resolvedHtml' => ImageNode::resolveMedia(
7481
$attrs['id'],
7582
$attrs['title'],
7683
$attrs['align'],
@@ -81,7 +88,7 @@ public function handleAjax(Doku_Event $event, $param)
8188
)
8289
];
8390
break;
84-
}
91+
}
8592
case 'resolveImageTitle':
8693
{
8794
$image = $INPUT->arr('image');
@@ -96,19 +103,19 @@ public function handleAjax(Doku_Event $event, $param)
96103
$image['cache']
97104
);
98105
break;
99-
}
106+
}
100107
case 'resolveRSS':
101108
{
102109
$attrs = json_decode($INPUT->str('attrs'), true);
103-
$responseData[$action] = \dokuwiki\plugin\prosemirror\parser\RSSNode::renderAttrsToHTML($attrs);
110+
$responseData[$action] = RSSNode::renderAttrsToHTML($attrs);
104111
break;
105-
}
112+
}
106113
default:
107114
{
108115
dbglog('Unknown action: ' . $action, __FILE__ . ': ' . __LINE__);
109116
http_status(400, 'unknown action');
110117
return;
111-
}
118+
}
112119
}
113120
}
114121

@@ -130,23 +137,23 @@ protected function resolveInterWikiLink($shortcut, $reference)
130137
protected function resolveInternalLink($inner, $curId)
131138
{
132139
if ($inner[0] === '#') {
133-
return dokuwiki\plugin\prosemirror\parser\LocalLinkNode::resolveLocalLink($inner, $curId);
140+
return LocalLinkNode::resolveLocalLink($inner, $curId);
134141
}
135-
return \dokuwiki\plugin\prosemirror\parser\InternalLinkNode::resolveLink($inner, $curId);
142+
return InternalLinkNode::resolveLink($inner, $curId);
136143
}
137144

138145
/**
139146
* [Custom event handler which performs action]
140147
*
141148
* Event: AJAX_CALL_UNKNOWN
142149
*
143-
* @param Doku_Event $event event object by reference
150+
* @param Event $event event object by reference
144151
* @param mixed $param [the parameters passed as fifth argument to register_hook() when this
145152
* handler was registered]
146153
*
147154
* @return void
148155
*/
149-
public function switchEditors(Doku_Event $event, $param)
156+
public function switchEditors(Event $event, $param)
150157
{
151158
if ($event->data !== 'plugin_prosemirror_switch_editors') {
152159
return;

‎action/editor.php‎

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<?php
2+
23
/**
34
* DokuWiki Plugin prosemirror (Action Component)
45
*
@@ -7,22 +8,26 @@
78
*/
89

910
// must be run within Dokuwiki
11+
use dokuwiki\Extension\ActionPlugin;
12+
use dokuwiki\Extension\EventHandler;
13+
use dokuwiki\Extension\Event;
14+
use dokuwiki\Form\Form;
1015
use dokuwiki\Form\ButtonElement;
1116

1217
if (!defined('DOKU_INC')) {
1318
die();
1419
}
1520

16-
class action_plugin_prosemirror_editor extends DokuWiki_Action_Plugin
21+
class action_plugin_prosemirror_editor extends ActionPlugin
1722
{
1823
/**
1924
* Registers a callback function for a given event
2025
*
21-
* @param Doku_Event_Handler $controller DokuWiki's event controller object
26+
* @param EventHandler $controller DokuWiki's event controller object
2227
*
2328
* @return void
2429
*/
25-
public function register(Doku_Event_Handler $controller)
30+
public function register(EventHandler $controller)
2631
{
2732
$controller->register_hook('ACTION_HEADERS_SEND', 'BEFORE', $this, 'forceWYSIWYG');
2833
$controller->register_hook('ACTION_HEADERS_SEND', 'AFTER', $this, 'addJSINFO');
@@ -36,10 +41,10 @@ public function register(Doku_Event_Handler $controller)
3641
*
3742
* Triggered by event: ACTION_HEADERS_SEND
3843
*
39-
* @param Doku_Event $event
44+
* @param Event $event
4045
* @param $param
4146
*/
42-
public function forceWYSIWYG(Doku_Event $event, $param)
47+
public function forceWYSIWYG(Event $event, $param)
4348
{
4449
if ($this->isForceWYSIWYG()) {
4550
set_doku_pref('plugin_prosemirror_useWYSIWYG', true);
@@ -51,19 +56,19 @@ public function forceWYSIWYG(Doku_Event $event, $param)
5156
*
5257
* Triggered by event: HTML_EDITFORM_OUTPUT
5358
*
54-
* @param Doku_Event $event event object
59+
* @param Event $event event object
5560
* @param mixed $param [the parameters passed as fifth argument to register_hook() when this
5661
* handler was registered]
5762
*
5863
* @return void
5964
*/
60-
public function addDataAndToggleButton(Doku_Event $event, $param)
65+
public function addDataAndToggleButton(Event $event, $param)
6166
{
6267
if (!$this->allowWYSIWYG()) {
6368
return;
6469
}
6570

66-
/** @var Doku_Form|\dokuwiki\Form\Form $form */
71+
/** @var Doku_Form|Form $form */
6772
$form = $event->data;
6873

6974
// return early if content is not editable
@@ -92,14 +97,14 @@ public function addDataAndToggleButton(Doku_Event $event, $param)
9297
}
9398
}
9499

95-
if (is_a($form, \dokuwiki\Form\Form::class)) {
100+
if (is_a($form, Form::class)) {
96101
$form->addElement($this->buildToggleButton(), 0);
97-
$form->setHiddenField('prosemirror_json',$prosemirrorJSON);
102+
$form->setHiddenField('prosemirror_json', $prosemirrorJSON);
98103
$form->addHTML('<div class="prosemirror_wrapper" id="prosemirror__editor"></div>', 1);
99104
} else {
100105
// todo remove when old stable is no longer supported
101106
$form->insertElement(0, $this->buildOldToggleButton());
102-
$form->addHidden('prosemirror_json',$prosemirrorJSON);
107+
$form->addHidden('prosemirror_json', $prosemirrorJSON);
103108
$form->insertElement(1, '<div class="prosemirror_wrapper" id="prosemirror__editor"></div>');
104109
}
105110
}
@@ -165,7 +170,7 @@ protected function allowWYSIWYG()
165170
return !$INPUT->has('target') || $INPUT->str('target') === 'section';
166171
}
167172

168-
public function addAddtionalForms(Doku_Event $event)
173+
public function addAddtionalForms(Event $event)
169174
{
170175
if (!$this->allowWYSIWYG()) {
171176
return;
@@ -175,12 +180,13 @@ public function addAddtionalForms(Doku_Event $event)
175180
return;
176181
}
177182

178-
$linkForm = new dokuwiki\Form\Form([
183+
$linkForm = new Form([
179184
'class' => 'plugin_prosemirror_linkform',
180185
'id' => 'prosemirror-linkform',
181186
'style' => 'display: none;',
182187
]);
183-
$linkForm->addFieldsetOpen('Links')->addClass('js-link-fieldset');;
188+
$linkForm->addFieldsetOpen('Links')->addClass('js-link-fieldset');
189+
;
184190
$iwOptions = array_keys(getInterwiki());
185191
$linkForm->addDropdown('iwshortcut', $iwOptions, 'InterWiki')->attr('required', 'required');
186192

@@ -190,7 +196,7 @@ public function addAddtionalForms(Doku_Event $event)
190196
]);
191197
$linkForm->addTextInput('linktarget', $this->getLang('link target'))->attrs(
192198
[
193-
'required'=> 'required',
199+
'required' => 'required',
194200
'autofocus' => 'autofocus',
195201
]
196202
);
@@ -229,7 +235,7 @@ public function addAddtionalForms(Doku_Event $event)
229235

230236
echo $linkForm->toHTML();
231237

232-
$mediaForm = new dokuwiki\Form\Form([
238+
$mediaForm = new Form([
233239
'class' => 'plugin_prosemirror_mediaform',
234240
'id' => 'prosemirror-mediaform',
235241
'style' => 'display: none;',
@@ -241,7 +247,7 @@ public function addAddtionalForms(Doku_Event $event)
241247
]);
242248
$mediaForm->addTextInput('mediatarget', $this->getLang('media target'))->attrs(
243249
[
244-
'required'=> 'required',
250+
'required' => 'required',
245251
'autofocus' => 'autofocus',
246252
]
247253
);
@@ -337,7 +343,7 @@ public function addJSINFO()
337343
*/
338344
protected function isReadOnly($form)
339345
{
340-
if (is_a($form, \dokuwiki\Form\Form::class)) {
346+
if (is_a($form, Form::class)) {
341347
$textareaPos = $form->findPositionByType('textarea');
342348
$readonly = $textareaPos !== false && !empty($form->getElementAt($textareaPos)->attr('readonly'));
343349
} else {

‎action/parser.php‎

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<?php
2+
23
/**
34
* DokuWiki Plugin prosemirror (Action Component)
45
*
@@ -7,23 +8,25 @@
78
*/
89

910
// must be run within Dokuwiki
11+
use dokuwiki\Extension\ActionPlugin;
12+
use dokuwiki\Extension\EventHandler;
13+
use dokuwiki\Extension\Event;
1014
use dokuwiki\plugin\prosemirror\parser\SyntaxTreeBuilder;
1115

1216
if (!defined('DOKU_INC')) {
1317
die();
1418
}
1519

16-
class action_plugin_prosemirror_parser extends DokuWiki_Action_Plugin
20+
class action_plugin_prosemirror_parser extends ActionPlugin
1721
{
18-
1922
/**
2023
* Registers a callback function for a given event
2124
*
22-
* @param Doku_Event_Handler $controller DokuWiki's event controller object
25+
* @param EventHandler $controller DokuWiki's event controller object
2326
*
2427
* @return void
2528
*/
26-
public function register(Doku_Event_Handler $controller)
29+
public function register(EventHandler $controller)
2730
{
2831
$controller->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'handle_preprocess');
2932
$controller->register_hook('DRAFT_SAVE', 'BEFORE', $this, 'handle_draft');
@@ -32,10 +35,10 @@ public function register(Doku_Event_Handler $controller)
3235
/**
3336
* Triggered by: COMMON_DRAFT_SAVE
3437
*
35-
* @param Doku_Event $event
38+
* @param Event $event
3639
* @param $param
3740
*/
38-
public function handle_draft(Doku_Event $event, $param)
41+
public function handle_draft(Event $event, $param)
3942
{
4043
global $INPUT;
4144
$unparsedJSON = $INPUT->post->str('prosemirror_json');
@@ -71,16 +74,17 @@ public function handle_draft(Doku_Event $event, $param)
7174
*
7275
* Triggered by: ACTION_ACT_PREPROCESS
7376
*
74-
* @param Doku_Event $event event object by reference
77+
* @param Event $event event object by reference
7578
* @param mixed $param [the parameters passed as fifth argument to register_hook() when this
7679
* handler was registered]
7780
*
7881
* @return void
7982
*/
80-
public function handle_preprocess(Doku_Event $event, $param)
83+
public function handle_preprocess(Event $event, $param)
8184
{
8285
global $TEXT, $INPUT;
83-
if ($INPUT->server->str('REQUEST_METHOD') !== 'POST'
86+
if (
87+
$INPUT->server->str('REQUEST_METHOD') !== 'POST'
8488
|| !in_array($event->data, ['save', 'preview'])
8589
|| !$INPUT->post->has('prosemirror_json')
8690
|| !get_doku_pref('plugin_prosemirror_useWYSIWYG', false)
@@ -111,7 +115,6 @@ public function handle_preprocess(Doku_Event $event, $param)
111115
$TEXT = $syntax;
112116
}
113117
}
114-
115118
}
116119

117120
// vim:ts=4:sw=4:et:

‎conf/default.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<?php
2+
23
/**
34
* Default settings for the prosemirror plugin
45
*

‎conf/metadata.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<?php
2+
23
/**
34
* Options for the prosemirror plugin
45
*

0 commit comments

Comments
 (0)