Add function param/return types, fix a lot more phpstorm complaints

1 files changed, 33 insertions, 34 deletions

diff --git a/modules-available/locations/inc/location.inc.php b/modules-available/locations/inc/location.inc.php
index f68d6821..59e6d2b6 100644
--- a/modules-available/locations/inc/location.inc.php
+++ b/modules-available/locations/inc/location.inc.php
@@ -17,7 +17,7 @@ class Location
 		return self::$treeCache;
 	}
 
-	public static function queryLocations()
+	public static function queryLocations(): array
 	{
 		$res = Database::simpleQuery("SELECT locationid, parentlocationid, locationname FROM location");
 		$rows = array();
@@ -29,10 +29,9 @@ class Location
 
 	/**
 	 * Return row from location table for $locationId.
-	 * @param $locationId
 	 * @return array|bool row from DB, false if not found
 	 */
-	public static function get($locationId)
+	public static function get(int $locationId)
 	{
 		return Database::queryFirst("SELECT * FROM location WHERE locationid = :locationId", compact('locationId'));
 	}
@@ -42,9 +41,8 @@ class Location
 	 * @param int $locationId id of location to get name for
 	 * @return string|false Name of location, false if locationId doesn't exist
 	 */
-	public static function getName($locationId)
+	public static function getName(int $locationId)
 	{
-		$locationId = (int)$locationId;
 		if (self::$assocLocationCache === false) {
 			self::getLocationsAssoc();
 		}
@@ -56,15 +54,13 @@ class Location
 	/**
 	 * Get all the names of the given location and its parents, up
 	 * to the root element. Array keys will be locationids, value the names.
-	 * @param int $locationId
 	 * @return array|false locations, from furthest to nearest or false if locationId doesn't exist
 	 */
-	public static function getNameChain($locationId)
+	public static function getNameChain(int $locationId)
 	{
 		if (self::$assocLocationCache === false) {
 			self::getLocationsAssoc();
 		}
-		$locationId = (int)$locationId;
 		if (!isset(self::$assocLocationCache[$locationId]))
 			return false;
 		$ret = array();
@@ -84,7 +80,7 @@ class Location
 		return self::$assocLocationCache;
 	}
 
-	private static function flattenTreeAssoc($tree, $parents = array(), $depth = 0)
+	private static function flattenTreeAssoc($tree, $parents = array(), $depth = 0): array
 	{
 		if ($depth > 20) {
 			ErrorHandler::traceError('Recursive location definition detected at ' . print_r($tree, true));
@@ -121,12 +117,12 @@ class Location
 
 	/**
 	 * @param int|int[] $selected Which locationIDs to mark as selected
-	 * @param int $excludeId Which locationID to explude
+	 * @param int $excludeId Which locationID to exclude
 	 * @param bool $addNoParent Add entry for "no location" at the top
 	 * @param bool $keepArrayKeys Keep location IDs as array index
 	 * @return array Locations
 	 */
-	public static function getLocations($selected = 0, $excludeId = 0, $addNoParent = false, $keepArrayKeys = false)
+	public static function getLocations($selected = 0, int $excludeId = 0, bool $addNoParent = false, bool $keepArrayKeys = false): array
 	{
 		if (self::$flatLocationCache === false) {
 			$rows = self::getTree();
@@ -173,7 +169,7 @@ class Location
 	 * @param bool $locationTree used in recursive calls, don't pass
 	 * @return array list of passed locations plus their children
 	 */
-	public static function getRecursive($idList, $locationTree = false)
+	public static function getRecursive($idList, bool $locationTree = false): array
 	{
 		if (!is_array($idList)) {
 			$idList = array($idList);
@@ -207,7 +203,7 @@ class Location
 		return $ret;
 	}
 
-	public static function buildTree($elements, $parentId = 0)
+	public static function buildTree(array $elements, int $parentId = 0): array
 	{
 		$branch = array();
 		$sort = array();
@@ -227,7 +223,7 @@ class Location
 		return $branch;
 	}
 
-	private static function flattenTree($tree, $depth = 0)
+	private static function flattenTree(array $tree, int $depth = 0): array
 	{
 		if ($depth > 20) {
 			ErrorHandler::traceError('Recursive location definition detected at ' . print_r($tree, true));
@@ -249,7 +245,8 @@ class Location
 		return $output;
 	}
 
-	public static function isLeaf($locationid) {
+	public static function isLeaf(int $locationid): bool
+	{
 		$result = Database::queryFirst('SELECT COUNT(locationid) = 0 AS isleaf '
 			. 'FROM location '
 			. 'WHERE parentlocationid = :locationid', ['locationid' => $locationid]);
@@ -257,7 +254,7 @@ class Location
 		return (bool)$result;
 	}
 
-	public static function extractIds($tree)
+	public static function extractIds(array $tree): array
 	{
 		$ids = array();
 		foreach ($tree as $node) {
@@ -271,10 +268,11 @@ class Location
 
 	/**
 	 * Get location id for given machine (by uuid)
+	 *
 	 * @param string $uuid machine uuid
-	 * @return bool|int locationid, false if no match
+	 * @return false|int locationid, false if no match
 	 */
-	public static function getFromMachineUuid($uuid)
+	public static function getFromMachineUuid(string $uuid)
 	{
 		// Only if we have the statistics module which supplies the machine table
 		if (Module::get('statistics') === false)
@@ -291,9 +289,9 @@ class Location
 	 *
 	 * @param string $ip IP address of client
 	 * @param bool $honorRoomPlanner consider a fixed location assigned manually by roomplanner
-	 * @return bool|int locationid, or false if no match
+	 * @return false|int locationid, or false if no match
 	 */
-	public static function getFromIp($ip, $honorRoomPlanner = false)
+	public static function getFromIp(string $ip, bool $honorRoomPlanner = false)
 	{
 		if (Module::get('statistics') !== false) {
 			// Shortcut - try to use subnetlocationid in machine table
@@ -322,17 +320,17 @@ class Location
 	 * client, so if it seems too fishy, the UUID will be ignored.
 	 *
 	 * @param string $ip IP address of client
-	 * @param string $uuid System-UUID of client
-	 * @return int|bool location id, or false if none matches
+	 * @param ?string $uuid System-UUID of client
+	 * @return int|false location id, or false if none matches
 	 */
-	public static function getFromIpAndUuid($ip, $uuid)
+	public static function getFromIpAndUuid(string $ip, ?string $uuid)
 	{
 		$locationId = false;
 		$ipLoc = self::getFromIp($ip);
 		if ($ipLoc !== false) {
 			// Set locationId to ipLoc for now, it will be overwritten later if another case applies.
 			$locationId = $ipLoc;
-			if ($uuid !== false) {
+			if ($uuid !== null) {
 				// Machine ip maps to a location, and we have a client supplied uuid (which might not be known if the client boots for the first time)
 				$uuidLoc = self::getFromMachineUuid($uuid);
 				if (self::isFixedLocationValid($uuidLoc, $ipLoc)) {
@@ -343,7 +341,7 @@ class Location
 		return $locationId;
 	}
 
-	public static function isFixedLocationValid($uuidLoc, $ipLoc)
+	public static function isFixedLocationValid($uuidLoc, $ipLoc): bool
 	{
 		if ($uuidLoc === false)
 			return false;
@@ -366,12 +364,10 @@ class Location
 	/**
 	 * Get all location IDs from the given location up to the root.
 	 *
-	 * @param int $locationId
 	 * @return int[] location ids, including $locationId
 	 */
-	public static function getLocationRootChain($locationId)
+	public static function getLocationRootChain(int $locationId): array
 	{
-		$locationId = (int)$locationId;
 		if (self::$assocLocationCache === false) {
 			self::getLocationsAssoc();
 		}
@@ -385,7 +381,7 @@ class Location
 	/**
 	 * @return array list of subnets as numeric array
 	 */
-	public static function getSubnets()
+	public static function getSubnets(): array
 	{
 		$res = Database::simpleQuery("SELECT startaddr, endaddr, locationid FROM subnet");
 		$subnets = array();
@@ -397,9 +393,9 @@ class Location
 	}
 
 	/**
-	 * @return array|bool assoc array mapping from locationid to subnets
+	 * @return array assoc array mapping from locationid to subnets
 	 */
-	public static function getSubnetsByLocation($recursive = false)
+	public static function getSubnetsByLocation($recursive = false): array
 	{
 		$locs = self::getLocationsAssoc();
 		$subnets = self::getSubnets();
@@ -433,9 +429,9 @@ class Location
 	 * random one will be returned.
 	 *
 	 * @param string $ip IP to look up
-	 * @return bool|int locationid ip matches, false = no match
+	 * @return false|int locationid ip matches, false = no match
 	 */
-	public static function mapIpToLocation($ip)
+	public static function mapIpToLocation(string $ip)
 	{
 		if (self::$subnetMapCache === false) {
 			self::$subnetMapCache = self::getSubnetsByLocation();
@@ -464,7 +460,10 @@ class Location
 		return (int)$best;
 	}
 
-	public static function updateMapIpToLocation($uuid, $ip)
+	/**
+	 * @return false|int newly determined location
+	 */
+	public static function updateMapIpToLocation(string $uuid, string $ip)
 	{
 		$loc = self::mapIpToLocation($ip);
 		if ($loc === false) {