Document messages in payload.

dereuromark · Apr 17, 2024 · da059eb · da059eb
1 parent ddb90a3
commit da059eb
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/plugins/Sandbox/src/Controller/AjaxExamplesController.php b/plugins/Sandbox/src/Controller/AjaxExamplesController.php
@@ -42,6 +42,9 @@ public function initialize(): void {
 
 		if (in_array($this->request->getParam('action'), ['redirectingPrevented', 'form', 'toggle', 'editInPlace', 'editInPlaceEmail', 'tableDelete'])) {
 			$this->loadComponent('Ajax.Ajax');
+			if ($this->request->getQuery('no-header')) {
+				$this->Flash->setConfig('noSessionOnAjax', false);
+			}
 		}
 
 		$this->viewBuilder()->addHelper('Data.Data');

diff --git a/plugins/Sandbox/templates/AjaxExamples/redirecting_prevented.php b/plugins/Sandbox/templates/AjaxExamples/redirecting_prevented.php
@@ -74,5 +74,14 @@
 	</div>
 </div>
 
+	<hr>
+
+	<p>
+		Note:
+		The example above also uses Flash plugin which auto-adds the flash messages as <code>X-Flash</code> header to the response.
+		If you want to keep the flash messages in the payload, you can also disable the header part using `'noSessionOnAjax'` config set to false (see code).
+		<?php echo $this->Html->link('Not using header but payload', ['?' => ['no-header' => true]]); ?>
+	</p>
+
 </div>