Advanced CLI commands: user:config:list

gh-153 in progress

Signed-off-by: Nicholas K. Dionysopoulos <[email protected]>

src/CliCommand/UserConfigList.php

@@ -0,0 +1,107 @@
+<?php
+/**
+ * @package   panopticon
+ * @copyright Copyright (c)2023-2024 Nicholas K. Dionysopoulos / Akeeba Ltd
+ * @license   https://www.gnu.org/licenses/agpl-3.0.txt GNU Affero General Public License, version 3 or later
+ */
+
+namespace Akeeba\Panopticon\CliCommand;
+
+defined('AKEEBA') || die;
+
+use Akeeba\Panopticon\CliCommand\Attribute\ConfigAssertion;
+use Akeeba\Panopticon\CliCommand\Trait\PrintFormattedArrayTrait;
+use Akeeba\Panopticon\Factory;
+use Akeeba\Panopticon\Model\Users;
+use Awf\Registry\Registry;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+#[AsCommand(
+	name: 'user:config:list',
+	description: 'List user configuration variables',
+	hidden: false,
+)]
+#[ConfigAssertion(true)]
+class UserConfigList extends AbstractCommand
+{
+	use PrintFormattedArrayTrait;
+
+	protected function execute(InputInterface $input, OutputInterface $output): int
+	{
+		$container = Factory::getContainer();
+		$ret       = [];
+
+		/** @var Users $model */
+		$model = $container->mvcFactory->makeTempModel('Users');
+		$id    = intval($input->getArgument('id'));
+
+		try
+		{
+			$model->findOrFail($id);
+		}
+		catch (\Exception $e)
+		{
+			$this->ioStyle->error(
+				[
+					sprintf('Could not find user %d', $id),
+					$e->getMessage(),
+				]
+			);
+		}
+
+		$config = $this->flatten((new Registry($model->parameters))->toArray());
+		$ret    = [];
+
+		foreach ($config as $k => $v)
+		{
+			$item['key']   = $k;
+			$item['value'] = $v;
+
+			$ret[] = $item;
+		}
+
+		// Output the information in the requested format
+		$this->printFormattedArray(
+			$ret,
+			$input->getOption('format') ?: 'table'
+		);
+
+		return Command::SUCCESS;
+	}
+
+	protected function configure(): void
+	{
+		$this
+			->addArgument('id', InputArgument::REQUIRED, 'The numeric user ID to list config values for')
+			->addOption(
+				'format', 'f', InputOption::VALUE_OPTIONAL, 'Output format (table, json, yaml, csv, count)', 'table'
+			);
+	}
+
+	private function flatten(array $array, $prefix = ''): array
+	{
+		$ret = [];
+
+		foreach ($array as $key => $value)
+		{
+			if (is_array($value))
+        	{
+        		foreach ($this->flatten($value, $prefix . $key . '.') as $k1 => $v1)
+		        {
+					$ret[$k1] = $v1;
+		        }
+        	}
+        	else
+        	{
+        		$ret[$prefix . $key] = $value;
+        	}
+		}
+
+		return $ret;
+	}
+}