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

---
 .../statistics/inc/statisticsfilter.inc.php        | 23 ++++++++--------------
 1 file changed, 8 insertions(+), 15 deletions(-)

(limited to 'modules-available/statistics/inc/statisticsfilter.inc.php')

diff --git a/modules-available/statistics/inc/statisticsfilter.inc.php b/modules-available/statistics/inc/statisticsfilter.inc.php
index cfc724c1..5e6448c7 100644
--- a/modules-available/statistics/inc/statisticsfilter.inc.php
+++ b/modules-available/statistics/inc/statisticsfilter.inc.php
@@ -94,9 +94,7 @@ abstract class StatisticsFilter
 
 	/**
 	 * Called to get an instance of DatabaseFilter that binds the given $op and $argument to this filter.
-	 * @param string $op
 	 * @param string[]|string $argument
-	 * @return DatabaseFilter
 	 */
 	public function bind(string $op, $argument): DatabaseFilter { return new DatabaseFilter($this, $op, $argument); }
 
@@ -109,6 +107,7 @@ abstract class StatisticsFilter
 		if (empty($this->ops))
 			return;
 		if (!in_array($operator, $this->ops)) {
+			// Yes keep $this in this call, get_class() !== get_class($this)
 			ErrorHandler::traceError("Invalid op '$operator' for " . get_class($this) . '::' . $this->column);
 		}
 	}
@@ -179,10 +178,7 @@ abstract class StatisticsFilter
 		return $filters;
 	}
 
-	/**
-	 * @param \StatisticsFilterSet $filterSet
-	 */
-	public static function renderFilterBox($show, $filterSet)
+	public static function renderFilterBox(string $show, StatisticsFilterSet $filterSet): void
 	{
 		// Build location list, with permissions
 		if (Module::isAvailable('locations')) {
@@ -194,7 +190,7 @@ abstract class StatisticsFilter
 		foreach (self::$columns as $key => $filter) {
 			$col = [
 				'key' => $key,
-				'name' => Dictionary::translateFile('filters', $key, true),
+				'name' => Dictionary::translateFile('filters', $key),
 				'placeholder' => $filter->placeholder,
 			];
 			$bind = $filterSet->hasFilterKey($key);
@@ -207,6 +203,7 @@ abstract class StatisticsFilter
 				$col['inputclass'] = 'is-date';
 			} elseif ($filter->type() === 'enum') {
 				$col['enum'] = true;
+				/** @var EnumStatisticsFilter $filter */
 				$col['values'] = $filter->values;
 				if ($bind !== null) {
 					// Current value from GET
@@ -550,15 +547,14 @@ class StateStatisticsFilter extends EnumStatisticsFilter
 	public function whereClause(string $operator, $argument, array &$args, array &$joins): string
 	{
 		$map = [ 'on' => ['IDLE', 'OCCUPIED'], 'off' => ['OFFLINE'], 'idle' => ['IDLE'], 'occupied' => ['OCCUPIED'], 'standby' => ['STANDBY'] ];
-		$neg = $operator == '!=' ? 'NOT ' : '';
+		$neg = $operator === '!=' ? 'NOT ' : '';
 		if (array_key_exists($argument, $map)) {
 			$key = StatisticsFilter::getNewKey($this->column);
 			$args[$key] = $map[$argument];
 			return " m.state $neg IN ( :$key ) ";
-		} else {
-			Message::addError('invalid-filter-argument', 'state', $argument);
-			return ' 1';
 		}
+		Message::addError('invalid-filter-argument', 'state', $argument);
+		return ' 1';
 	}
 }
 
@@ -623,7 +619,7 @@ class IpStatisticsFilter extends StatisticsFilter
 		} elseif (strpos($argument, '/') !== false) {
 			// TODO: IPv6 CIDR
 			$range = IpUtil::parseCidr($argument);
-			if ($range === false) {
+			if ($range === null) {
 				Message::addError('invalid-cidr-notion', $argument);
 				return '0';
 			}
@@ -838,9 +834,6 @@ class DatabaseFilter
 
 	/**
 	 * Called from StatisticsFilterSet::makeFragments() to build the final query.
-	 * @param array $args
-	 * @param array $joins
-	 * @return string
 	 */
 	public function whereClause(array &$args, array &$joins): string
 	{
-- 
cgit v1.2.3-55-g7522