Use new templating plugin where possible. (#416)

* Use new templating plugin where possible. * Fix CS * Update yes_no.php
dereuromark · Mar 11, 2024 · 0ee9d56 · 0ee9d56
1 parent 3a587de
commit 0ee9d56
Show file tree

Hide file tree

Showing 9 changed files with 36 additions and 9 deletions.
diff --git a/composer.json b/composer.json
@@ -35,6 +35,7 @@
 		"cakephp/bake": "^3.0.1",
 		"cakephp/migrations": "^4.0.1",
 		"dereuromark/cakephp-ide-helper": "^2.0.0",
+		"dereuromark/cakephp-templating": "^0.2.1",
 		"dereuromark/cakephp-tools": "^3.0.0",
 		"dereuromark/cakephp-dto": "^2.1.0",
 		"fig-r/psr2r-sniffer": "dev-next",

diff --git a/config/app.example.php b/config/app.example.php
@@ -5,7 +5,7 @@
  *
  * To modify these parameters, copy this file into your own CakePHP config directory or copy the array into your existing file.
  */
-use Tools\View\Icon\BootstrapIcon;
+use Templating\View\Icon\BootstrapIcon;
 
 return [
 	'Queue' => [

diff --git a/src/Controller/Admin/LoadHelperTrait.php b/src/Controller/Admin/LoadHelperTrait.php
@@ -4,6 +4,7 @@
 namespace Queue\Controller\Admin;
 
 use Templating\View\Helper\IconHelper;
+use Templating\View\Helper\IconSnippetHelper;
 
 trait LoadHelperTrait {
 
@@ -12,12 +13,15 @@ trait LoadHelperTrait {
 	 */
 	protected function loadHelpers(): void {
 		$helpers = [
-			'Tools.Time',
+			'Shim.Configure',
 			'Tools.Format',
-			class_exists(IconHelper::class) ? 'Templating.Icon' : 'Tools.Icon',
 			'Tools.Text',
-			'Shim.Configure',
+			'Tools.Time',
+			class_exists(IconHelper::class) ? 'Templating.Icon' : 'Tools.Icon',
 		];
+		if (class_exists(IconSnippetHelper::class)) {
+			$helpers[] = 'Templating.IconSnippet';
+		}
 
 		$this->viewBuilder()->addHelpers($helpers);
 	}

diff --git a/templates/Admin/Queue/index.php b/templates/Admin/Queue/index.php
@@ -37,7 +37,7 @@
 			$time = $status['time'];
 			$running = $time->addMinutes(1)->isFuture();
 			?>
-			<?php echo $this->Format->yesNo($running); ?> <?php echo $running ? __d('queue', 'Running') : __d('queue', 'Not running'); ?> (<?php echo __d('queue', 'last {0}', $this->Time->relLengthOfTime($status['time']))?>)
+			<?php echo $this->element('Queue.yes_no', ['value' => $running]); ?> <?php echo $running ? __d('queue', 'Running') : __d('queue', 'Not running'); ?> (<?php echo __d('queue', 'last {0}', $this->Time->relLengthOfTime($status['time']))?>)
 
 			<?php
 			echo '<div><small>Currently ' . $this->Html->link($status['workers'] . ' worker(s)', ['action' => 'processes']) . ' total.</small></div>';
@@ -136,7 +136,7 @@
 		Server:
 		<ul>
 			<li>
-				<code>posix</code> extension enabled (optional, recommended): <?php echo $this->Format->yesNo(function_exists('posix_kill')); ?>
+				<code>posix</code> extension enabled (optional, recommended): <?php echo $this->element('Queue.yes_no', ['value' => function_exists('posix_kill')]); ?>
 			</li>
 		</ul>
 

diff --git a/templates/Admin/QueueProcesses/index.php b/templates/Admin/QueueProcesses/index.php
@@ -50,7 +50,7 @@
 						echo $modified;
 					?>
 				</td>
-				<td><?= $this->Format->yesNo(!$queueProcess->terminate) ?></td>
+				<td><?= $this->element('Queue.yes_no', ['value' => !$queueProcess->terminate]) ?></td>
 				<td><?= h($queueProcess->server) ?></td>
 				<td class="actions">
 					<?= $this->Html->link($this->Icon->render('view'), ['action' => 'view', $queueProcess->id], ['escapeTitle' => false]); ?>

diff --git a/templates/Admin/QueueProcesses/view.php b/templates/Admin/QueueProcesses/view.php
@@ -37,7 +37,10 @@
 		</tr>
 		<tr>
 			<th><?= __d('queue', 'Active') ?></th>
-			<td><?= $this->Format->yesNo(!$queueProcess->terminate) ?></td>
+			<td>
+				<?= $this->element('Queue.yes_no', ['value' => !$queueProcess->terminate]) ?>
+				<?php echo !$queueProcess->terminate ? 'Yes' : 'No' ?>
+			</td>
 		</tr>
 		<tr>
 			<th><?= __d('queue', 'Server') ?></th>

diff --git a/templates/element/yes_no.php b/templates/element/yes_no.php
@@ -0,0 +1,17 @@
+<?php
+/**
+ * Overwrite this element snippet locally to customize if needed.
+ *
+ * @var \App\View\AppView $this
+ * @var bool $value
+ */
+?>
+<?php
+	if ($this->helpers()->has('IconSnippet')) {
+		echo $this->IconSnippet->yesNo($value);
+	} elseif ($this->helpers()->has('Format')) {
+		echo $this->Format->yesNo($value);
+	} else {
+		echo $value ? '<span class="yes-no yes-no-yes">Yes</span>' : '<span class="yes-no yes-no-no">No</span>';
+	}
+?>
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
@@ -11,9 +11,9 @@
 use Foo\FooPlugin;
 use Queue\QueuePlugin;
 use Shim\Filesystem\Folder;
+use Templating\View\Icon\BootstrapIcon;
 use TestApp\Controller\AppController;
 use TestApp\View\AppView;
-use Tools\View\Icon\BootstrapIcon;
 
 if (!defined('DS')) {
 	define('DS', DIRECTORY_SEPARATOR);

diff --git a/tests/test_app/src/View/AppView.php b/tests/test_app/src/View/AppView.php
@@ -9,6 +9,8 @@
  * Fake AppView for IDE autocomplete it templates
  *
  * @property \Tools\View\Helper\FormatHelper $Format
+ * @property \Templating\View\Helper\IconHelper $Icon
+ * @property \Templating\View\Helper\IconSnippetHelper $IconSnippet
  * @property \Tools\View\Helper\TimeHelper $Time
  * @property \Queue\View\Helper\QueueHelper $Queue
  * @property \Queue\View\Helper\QueueProgressHelper $QueueProgress