From 06bff0b9b84d47c43f9bc8aff06a29d85ebb7ed0 Mon Sep 17 00:00:00 2001
From: Simon Rettberg
Date: Tue, 14 Nov 2023 14:47:55 +0100
Subject: Add function param/return types, fix a lot more phpstorm complaints

---
 modules-available/sysconfig/addconfig.inc.php | 44 +++++++++++----------------
 1 file changed, 17 insertions(+), 27 deletions(-)

(limited to 'modules-available/sysconfig/addconfig.inc.php')

diff --git a/modules-available/sysconfig/addconfig.inc.php b/modules-available/sysconfig/addconfig.inc.php
index 8df700f9..27af31e8 100644
--- a/modules-available/sysconfig/addconfig.inc.php
+++ b/modules-available/sysconfig/addconfig.inc.php
@@ -9,21 +9,17 @@ abstract class AddConfig_Base
 
 	/**
 	 * Holds the instance for the currently executing step
-	 * @var \AddConfig_Base
+	 * @var AddConfig_Base
 	 */
-	private static $instance = false;
+	private static $instance = null;
 	
 	/**
 	 * Config being edited (if any)
-	 * @var \ConfigTgz
+	 * @var ?ConfigTgz
 	 */
-	protected $edit = false;
+	protected $edit = null;
 
-	/**
-	 * 
-	 * @param string $step
-	 */
-	public static function setStep($step)
+	public static function setStep(string $step)
 	{
 		if (empty($step) || !class_exists($step) || get_parent_class($step) !== 'AddConfig_Base') {
 			Message::addError('invalid-action', $step);
@@ -32,18 +28,12 @@ abstract class AddConfig_Base
 		self::$instance = new $step();
 		if (($editId = Request::any('edit', 0, 'int')) !== 0) {
 			self::$instance->edit = ConfigTgz::get($editId);
-			if (self::$instance->edit === false)
+			if (self::$instance->edit === null)
 				ErrorHandler::traceError('Invalid config id for editing');
 			Util::addRedirectParam('edit', self::$instance->edit->id());
 		}
 	}
 
-	protected function tmError()
-	{
-		Message::addError('main.taskmanager-error');
-		Util::redirect('?do=SysConfig');
-	}
-
 	/**
 	 * Called before any HTML rendering happens, so you can
 	 * prepare stuff, validate input, and optionally redirect
@@ -73,7 +63,7 @@ abstract class AddConfig_Base
 	
 	public static function preprocess()
 	{
-		if (self::$instance === false) {
+		if (self::$instance === null) {
 			ErrorHandler::traceError('No step instance yet');
 		}
 		self::$instance->preprocessInternal();
@@ -81,16 +71,16 @@ abstract class AddConfig_Base
 	
 	public static function render()
 	{
-		if (self::$instance === false)
+		if (self::$instance === null)
 			ErrorHandler::traceError('No step instance yet');
-		if (self::$instance->edit !== false)
+		if (self::$instance->edit !== null)
 			Message::addInfo('replacing-config', self::$instance->edit->title());
 		self::$instance->renderInternal();
 	}
 	
 	public static function ajax()
 	{
-		if (self::$instance === false) {
+		if (self::$instance === null) {
 			ErrorHandler::traceError('No step instance yet');
 		}
 		self::$instance->ajaxInternal();
@@ -110,7 +100,7 @@ class AddConfig_Start extends AddConfig_Base
 		$mods = ConfigModule::getList();
 		$res = Database::simpleQuery("SELECT moduleid, title, moduletype, filepath FROM configtgz_module"
 			. " ORDER BY title ASC"); // Move to ConfigModule
-		if ($this->edit === false) {
+		if ($this->edit === null) {
 			$active = array();
 		} else {
 			$active = $this->edit->getModuleIds();
@@ -140,7 +130,7 @@ class AddConfig_Start extends AddConfig_Base
 			$row['active'] = in_array($row['moduleid'], $active);
 			$group['modules'][] = $row;
 		}
-		if ($this->edit !== false) {
+		if ($this->edit !== null) {
 			$title = $this->edit->title();
 		} else {
 			$title = Request::any('title', '', 'string');
@@ -162,7 +152,7 @@ class AddConfig_Start extends AddConfig_Base
 			'step' => 'AddConfig_Finish',
 			'groups' => array_values($modGroups),
 			'title' => $title,
-			'edit' => ($this->edit !== false ? $this->edit->id() : false)
+			'edit' => $this->edit === null ? null : $this->edit->id(),
 		));
 	}
 
@@ -174,9 +164,9 @@ class AddConfig_Start extends AddConfig_Base
 class AddConfig_Finish extends AddConfig_Base
 {
 	/**
-	 * @var ConfigTgz
+	 * @var ?ConfigTgz
 	 */
-	private $config = false;
+	private $config = null;
 	
 	protected function preprocessInternal()
 	{
@@ -186,13 +176,13 @@ class AddConfig_Finish extends AddConfig_Base
 			Message::addError('missing-file');
 			Util::redirect('?do=SysConfig&action=addconfig');
 		}
-		if ($this->edit === false) {
+		if ($this->edit === null) {
 			$this->config = ConfigTgz::insert($title, $modules);
 		} else {
 			$this->edit->update($title, $modules);
 			$this->config = $this->edit;
 		}
-		if ($this->config === false || $this->config->generate(true, 150) === false) {
+		if ($this->config->generate(true, 150) === false) {
 			Message::addError('unsuccessful-action');
 			Util::redirect('?do=SysConfig&action=addconfig');
 		}
-- 
cgit v1.2.3-55-g7522