Skip to content

Commit d89bb27

Browse files
committed
Replace some 'echo' with ResponseRenderer::addHTML() method
Signed-off-by: Maurício Meneghini Fauth <mauricio@fauth.dev>
1 parent 41996de commit d89bb27

12 files changed

Lines changed: 76 additions & 142 deletions

libraries/classes/Controllers/ChangeLogController.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ public function __invoke(ServerRequest $request): void
104104

105105
$this->response->header('Content-type: text/html; charset=utf-8');
106106

107-
echo $this->template->render('changelog', [
107+
$this->render('changelog', [
108108
'changelog' => preg_replace(array_keys($replaces), $replaces, $changelog),
109109
]);
110110
}

libraries/classes/Controllers/Database/CentralColumnsController.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public function __invoke(ServerRequest $request): void
3737
$GLOBALS['num_cols'] ??= null;
3838

3939
if ($request->hasBodyParam('edit_save')) {
40-
echo $this->editSave([
40+
$this->response->addHTML((string) $this->editSave([
4141
'col_name' => $request->getParsedBodyParam('col_name'),
4242
'orig_col_name' => $request->getParsedBodyParam('orig_col_name'),
4343
'col_default' => $request->getParsedBodyParam('col_default'),
@@ -48,7 +48,7 @@ public function __invoke(ServerRequest $request): void
4848
'col_attribute' => $request->getParsedBodyParam('col_attribute'),
4949
'col_type' => $request->getParsedBodyParam('col_type'),
5050
'collation' => $request->getParsedBodyParam('collation'),
51-
]);
51+
]));
5252

5353
return;
5454
}

libraries/classes/Controllers/Database/TrackingController.php

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -60,23 +60,23 @@ public function __invoke(ServerRequest $request): void
6060

6161
if ($request->hasBodyParam('delete_tracking') && $request->hasBodyParam('table')) {
6262
$this->tracking->deleteTracking($GLOBALS['db'], $request->getParsedBodyParam('table'));
63-
echo Message::success(
63+
$this->response->addHTML(Message::success(
6464
__('Tracking data deleted successfully.'),
65-
)->getDisplay();
65+
)->getDisplay());
6666
} elseif ($request->hasBodyParam('submit_create_version')) {
6767
$this->tracking->createTrackingForMultipleTables(
6868
$GLOBALS['db'],
6969
$request->getParsedBodyParam('selected'),
7070
$request->getParsedBodyParam('version'),
7171
);
72-
echo Message::success(
72+
$this->response->addHTML(Message::success(
7373
sprintf(
7474
__(
7575
'Version %1$s was created for selected tables, tracking is active for them.',
7676
),
7777
htmlspecialchars($request->getParsedBodyParam('version')),
7878
),
79-
)->getDisplay();
79+
)->getDisplay());
8080
} elseif ($request->hasBodyParam('submit_mult')) {
8181
$selectedTable = $request->getParsedBodyParam('selected_tbl');
8282
if (! empty($selectedTable)) {
@@ -85,11 +85,11 @@ public function __invoke(ServerRequest $request): void
8585
$this->tracking->deleteTracking($GLOBALS['db'], $table);
8686
}
8787

88-
echo Message::success(
88+
$this->response->addHTML(Message::success(
8989
__('Tracking data deleted successfully.'),
90-
)->getDisplay();
90+
)->getDisplay());
9191
} elseif ($request->getParsedBodyParam('submit_mult') === 'track') {
92-
echo $this->template->render('create_tracking_version', [
92+
$this->render('create_tracking_version', [
9393
'route' => '/database/tracking',
9494
'url_params' => $GLOBALS['urlParams'],
9595
'last_version' => 0,
@@ -102,9 +102,9 @@ public function __invoke(ServerRequest $request): void
102102
return;
103103
}
104104
} else {
105-
echo Message::notice(
105+
$this->response->addHTML(Message::notice(
106106
__('No tables selected.'),
107-
)->getDisplay();
107+
)->getDisplay());
108108
}
109109
}
110110

@@ -113,19 +113,21 @@ public function __invoke(ServerRequest $request): void
113113

114114
// No tables present and no log exist
115115
if ($numTables === 0 && $trackedData->ddlog === []) {
116-
echo '<p>' , __('No tables found in database.') , '</p>' , "\n";
116+
$this->response->addHTML('<p>' . __('No tables found in database.') . '</p>' . "\n");
117117

118118
if (! $isSystemSchema) {
119119
$checkUserPrivileges = new CheckUserPrivileges($this->dbi);
120120
$checkUserPrivileges->getPrivileges();
121121

122-
echo $this->template->render('database/create_table', ['db' => $GLOBALS['db']]);
122+
$this->render('database/create_table', ['db' => $GLOBALS['db']]);
123123
}
124124

125125
return;
126126
}
127127

128-
echo $this->tracking->getHtmlForDbTrackingTables($GLOBALS['db'], $GLOBALS['urlParams'], $GLOBALS['text_dir']);
128+
$this->response->addHTML(
129+
$this->tracking->getHtmlForDbTrackingTables($GLOBALS['db'], $GLOBALS['urlParams'], $GLOBALS['text_dir']),
130+
);
129131

130132
// If available print out database log
131133
if ($trackedData->ddlog === []) {
@@ -138,6 +140,6 @@ public function __invoke(ServerRequest $request): void
138140
. $entry['statement'] . "\n";
139141
}
140142

141-
echo Generator::getMessage(__('Database Log'), $log);
143+
$this->response->addHTML(Generator::getMessage(__('Database Log'), $log));
142144
}
143145
}

libraries/classes/Controllers/Preferences/ManageController.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -168,13 +168,13 @@ public function __invoke(ServerRequest $request): void
168168
// mimic original form and post json in a hidden field
169169
$relationParameters = $this->relation->getRelationParameters();
170170

171-
echo $this->template->render('preferences/header', [
171+
$this->render('preferences/header', [
172172
'route' => $route,
173173
'is_saved' => $request->hasQueryParam('saved'),
174174
'has_config_storage' => $relationParameters->userPreferencesFeature !== null,
175175
]);
176176

177-
echo $this->template->render('preferences/manage/error', [
177+
$this->render('preferences/manage/error', [
178178
'form_errors' => $formDisplay->displayErrors(),
179179
'json' => $json,
180180
'import_merge' => $request->getParsedBodyParam('import_merge'),
@@ -244,7 +244,7 @@ public function __invoke(ServerRequest $request): void
244244

245245
$relationParameters = $this->relation->getRelationParameters();
246246

247-
echo $this->template->render('preferences/header', [
247+
$this->render('preferences/header', [
248248
'route' => $route,
249249
'is_saved' => $request->hasQueryParam('saved'),
250250
'has_config_storage' => $relationParameters->userPreferencesFeature !== null,
@@ -258,7 +258,7 @@ public function __invoke(ServerRequest $request): void
258258
$GLOBALS['error']->getDisplay();
259259
}
260260

261-
echo $this->template->render('preferences/manage/main', [
261+
$this->render('preferences/manage/main', [
262262
'error' => $GLOBALS['error'],
263263
'max_upload_size' => $GLOBALS['config']->get('max_upload_size'),
264264
'exists_setup_and_not_exists_config' => @file_exists(ROOT_PATH . 'setup/index.php')

libraries/classes/Controllers/Preferences/TwoFactorController.php

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public function __invoke(ServerRequest $request): void
2727
{
2828
$relationParameters = $this->relation->getRelationParameters();
2929

30-
echo $this->template->render('preferences/header', [
30+
$this->render('preferences/header', [
3131
'route' => $request->getRoute(),
3232
'is_saved' => $request->hasQueryParam('saved'),
3333
'has_config_storage' => $relationParameters->userPreferencesFeature !== null,
@@ -37,28 +37,32 @@ public function __invoke(ServerRequest $request): void
3737

3838
if ($request->hasBodyParam('2fa_remove')) {
3939
if (! $twoFactor->check(true)) {
40-
echo $this->template->render('preferences/two_factor/confirm', ['form' => $twoFactor->render()]);
40+
$this->render('preferences/two_factor/confirm', ['form' => $twoFactor->render()]);
4141

4242
return;
4343
}
4444

4545
$twoFactor->configure('');
46-
echo Message::rawNotice(__('Two-factor authentication has been removed.'))->getDisplay();
46+
$this->response->addHTML(
47+
Message::rawNotice(__('Two-factor authentication has been removed.'))->getDisplay(),
48+
);
4749
} elseif ($request->hasBodyParam('2fa_configure')) {
4850
if (! $twoFactor->configure($request->getParsedBodyParam('2fa_configure'))) {
49-
echo $this->template->render('preferences/two_factor/configure', [
51+
$this->render('preferences/two_factor/configure', [
5052
'form' => $twoFactor->setup(),
5153
'configure' => $request->getParsedBodyParam('2fa_configure'),
5254
]);
5355

5456
return;
5557
}
5658

57-
echo Message::rawNotice(__('Two-factor authentication has been configured.'))->getDisplay();
59+
$this->response->addHTML(
60+
Message::rawNotice(__('Two-factor authentication has been configured.'))->getDisplay(),
61+
);
5862
}
5963

6064
$backend = $twoFactor->getBackend();
61-
echo $this->template->render('preferences/two_factor/main', [
65+
$this->render('preferences/two_factor/main', [
6266
'enabled' => $twoFactor->isWritable(),
6367
'num_backends' => count($twoFactor->getAvailable()),
6468
'backend_id' => $backend::$id,

libraries/classes/Controllers/View/CreateController.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ public function __invoke(ServerRequest $request): void
166166

167167
$this->addScriptFiles(['sql.js']);
168168

169-
echo $this->template->render('view_create', [
169+
$this->render('view_create', [
170170
'ajax_dialog' => $ajaxdialog,
171171
'text_dir' => $GLOBALS['text_dir'],
172172
'url_params' => $GLOBALS['urlParams'],

libraries/classes/Plugins/Auth/AuthenticationCookie.php

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ public function showLoginForm(): never
166166

167167
$configFooter = Config::renderFooter();
168168

169-
echo $this->template->render('login/form', [
169+
$response->addHTML($this->template->render('login/form', [
170170
'login_header' => $loginHeader,
171171
'is_demo' => $GLOBALS['cfg']['DBG']['demo'],
172172
'error_messages' => $errorMessages,
@@ -195,7 +195,7 @@ public function showLoginForm(): never
195195
'errors' => $errors,
196196
'login_footer' => $loginFooter,
197197
'config_footer' => $configFooter,
198-
]);
198+
]));
199199

200200
$response->callExit();
201201
}
@@ -321,13 +321,14 @@ public function readCredentials(): bool
321321
/* Secure current session on login to avoid session fixation */
322322
Session::secure();
323323
} catch (SessionHandlerException $exception) {
324-
echo (new Template())->render('error/generic', [
324+
$responseRenderer = ResponseRenderer::getInstance();
325+
$responseRenderer->addHTML((new Template())->render('error/generic', [
325326
'lang' => $GLOBALS['lang'] ?? 'en',
326327
'dir' => $GLOBALS['text_dir'] ?? 'ltr',
327328
'error_message' => $exception->getMessage(),
328-
]);
329+
]));
329330

330-
ResponseRenderer::getInstance()->callExit();
331+
$responseRenderer->callExit();
331332
}
332333

333334
return true;

libraries/classes/Plugins/AuthenticationPlugin.php

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -242,13 +242,14 @@ public function authenticate(): void
242242
try {
243243
Session::secure();
244244
} catch (SessionHandlerException $exception) {
245-
echo (new Template())->render('error/generic', [
245+
$responseRenderer = ResponseRenderer::getInstance();
246+
$responseRenderer->addHTML((new Template())->render('error/generic', [
246247
'lang' => $GLOBALS['lang'] ?? 'en',
247248
'dir' => $GLOBALS['text_dir'] ?? 'ltr',
248249
'error_message' => $exception->getMessage(),
249-
]);
250+
]));
250251

251-
ResponseRenderer::getInstance()->callExit();
252+
$responseRenderer->callExit();
252253
}
253254

254255
$this->showLoginForm();
@@ -316,16 +317,16 @@ public function checkTwoFactor(): void
316317
$response->callExit();
317318
}
318319

319-
echo $this->template->render('login/header');
320-
echo Message::rawNotice(
320+
$response->addHTML($this->template->render('login/header'));
321+
$response->addHTML(Message::rawNotice(
321322
__('You have enabled two factor authentication, please confirm your login.'),
322-
)->getDisplay();
323-
echo $this->template->render('login/twofactor', [
323+
)->getDisplay());
324+
$response->addHTML($this->template->render('login/twofactor', [
324325
'form' => $twofactor->render(),
325326
'show_submit' => $twofactor->showSubmit(),
326-
]);
327-
echo $this->template->render('login/footer');
328-
echo Config::renderFooter();
327+
]));
328+
$response->addHTML($this->template->render('login/footer'));
329+
$response->addHTML(Config::renderFooter());
329330
$response->callExit();
330331
}
331332
}

libraries/classes/Tracking/Tracking.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ public function getHtmlForTrackingReport(
233233
// First, list tracked data definition statements
234234
if ($trackedData->ddlog === [] && $trackedData->dmlog === []) {
235235
$msg = Message::notice(__('No data'));
236-
echo $msg->getDisplay();
236+
$html .= $msg->getDisplay();
237237
}
238238

239239
$html .= $this->getHtmlForTrackingReportExportForm1(

phpstan-baseline.neon

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31082,7 +31082,7 @@ parameters:
3108231082

3108331083
-
3108431084
message: "#^Cannot access offset 'Servers' on mixed\\.$#"
31085-
count: 10
31085+
count: 9
3108631086
path: test/classes/Plugins/Auth/AuthenticationCookieTest.php
3108731087

3108831088
-

0 commit comments

Comments
 (0)