2297 cli parameters consistency (#6028)

* Updates do-install params

* Adds parseCliParams to _cli.php

* Updates do-install to use parseCliParams

* Updates reconfigure to use parseCliParams

* Fixes bug mail_login => email

* Update create-user to use parseCliParams

* Minor refactor

* Updates update-user to use parseCliParams

* Fix no_default_feeds => no-default-feeds

* Refactors arrays

* Updates CLI Readme

* Adds docblocks to _cli functions

* Sets vars in _cli functions

* Fixes indentation

* Meeting coding standards around colons

* Meeting PHPStan standards

* Removes stray whitespace

* Meeting PHPStan Next Level standards

* More specific typing

* Maintaining types

* Typing around getopt()

* Fixes typo

* Fixes typo perameters -> parameters

* Removes unused variable

* Rewrites deprecation warning message

1 files changed, 38 insertions, 27 deletions

diff --git a/cli/_update-or-create-user.php b/cli/_update-or-create-user.php
index 385bbd549..23666e3ae 100644
--- a/cli/_update-or-create-user.php
+++ b/cli/_update-or-create-user.php
@@ -4,56 +4,67 @@ require(__DIR__ . '/_cli.php');
 
 performRequirementCheck(FreshRSS_Context::systemConf()->db['type'] ?? '');
 
-$params = array(
-		'user:',
-		'password:',
-		'api_password:',
-		'language:',
-		'email:',
-		'token:',
-		'purge_after_months:',
-		'feed_min_articles_default:',
-		'feed_ttl_default:',
-		'since_hours_posts_per_rss:',
-		'max_posts_per_rss:',
-	);
+$parameters = array(
+	'valid' => array(
+		'user' => ':',
+		'password' => ':',
+		'api-password' => ':',
+		'language' => ':',
+		'email' => ':',
+		'token' => ':',
+		'purge-after-months' => ':',
+		'feed-min-articles-default' => ':',
+		'feed-ttl-default' => ':',
+		'since-hours-posts-per-rss' => ':',
+		'max-posts-per-rss' => ':',
+	),
+	'deprecated' => array(
+		'api-password' => 'api_password',
+		'purge-after-months' => 'purge_after_months',
+		'feed-min-articles-default' => 'feed_min_articles_default',
+		'feed-ttl-default' => 'feed_ttl_default',
+		'since-hours-posts-per-rss' => 'since_hours_posts_per_rss',
+		'max-posts-per-rss' => 'max_posts_per_rss',
+	),
+);
 
 if (!isset($isUpdate)) {
 	$isUpdate = false;
 } elseif (!$isUpdate) {
-	$params[] = 'no_default_feeds';	//Only for creating new users
+	$parameters['valid']['no-default-feeds'] = '';	//Only for creating new users
+	$parameters['deprecated']['no-default-feeds'] = 'no_default_feeds';
 }
 
-$GLOBALS['options'] = getopt('', $params);
+$GLOBALS['options'] = parseCliParams($parameters);
 
-if (!validateOptions($argv, $params) || empty($options['user'])) {
+if (!empty($options['invalid']) || empty($options['valid']['user'])) {
 	fail('Usage: ' . basename($_SERVER['SCRIPT_FILENAME']) .
-		" --user username ( --password 'password' --api_password 'api_password'" .
+		" --user username ( --password 'password' --api-password 'api_password'" .
 		" --language en --email user@example.net --token 'longRandomString'" .
-		($isUpdate ? '' : ' --no_default_feeds') .
-		" --purge_after_months 3 --feed_min_articles_default 50 --feed_ttl_default 3600" .
-		" --since_hours_posts_per_rss 168 --max_posts_per_rss 400 )");
+		($isUpdate ? '' : ' --no-default-feeds') .
+		" --purge-after-months 3 --feed-min-articles-default 50 --feed-ttl-default 3600" .
+		" --since-hours-posts-per-rss 168 --max-posts-per-rss 400 )");
 }
 
 function strParam(string $name): ?string {
 	global $options;
-	return isset($options[$name]) ? strval($options[$name]) : null;
+	return isset($options['valid'][$name]) ? strval($options['valid'][$name]) : null;
 }
 
 function intParam(string $name): ?int {
 	global $options;
-	return isset($options[$name]) && ctype_digit($options[$name]) ? intval($options[$name]) : null;
+	return isset($options['valid'][$name]) && ctype_digit($options['valid'][$name]) ? intval($options['valid'][$name]) : null;
 }
 
 $values = array(
 		'language' => strParam('language'),
 		'mail_login' => strParam('email'),
 		'token' => strParam('token'),
-		'old_entries' => intParam('purge_after_months'),	//TODO: Update with new mechanism
-		'keep_history_default' => intParam('feed_min_articles_default'),	//TODO: Update with new mechanism
-		'ttl_default' => intParam('feed_ttl_default'),
-		'since_hours_posts_per_rss' => intParam('since_hours_posts_per_rss'),
-		'max_posts_per_rss' => intParam('max_posts_per_rss'),
+		'old_entries' => intParam('purge-after-months'),	//TODO: Update with new mechanism
+		'keep_history_default' => intParam('feed-min-articles-default'),	//TODO: Update with new mechanism
+		'ttl_default' => intParam('feed-ttl-default'),
+		'since_hours_posts_per_rss' => intParam('since-hours-posts-per-rss'),
+		'max_posts_per_rss' => intParam('max-posts-per-rss'),
 	);
 
 $values = array_filter($values);