[locationinfo] Add types

9 files changed, 68 insertions, 79 deletions

diff --git a/modules-available/locationinfo/api.inc.php b/modules-available/locationinfo/api.inc.php
index e1c35525..2fbf1e84 100644
--- a/modules-available/locationinfo/api.inc.php
+++ b/modules-available/locationinfo/api.inc.php
@@ -178,7 +178,7 @@ function getCalendar($idList)
 	foreach ($dbquery as $dbresult) {
 		if (!isset($serverList[$dbresult['serverid']])) {
 			$serverList[$dbresult['serverid']] = array(
-				'credentials' => json_decode($dbresult['credentials'], true),
+				'credentials' => (array)json_decode($dbresult['credentials'], true),
 				'type' => $dbresult['servertype'],
 				'idlist' => array()
 			);
diff --git a/modules-available/locationinfo/inc/coursebackend.inc.php b/modules-available/locationinfo/inc/coursebackend.inc.php
index 045952ed..72494214 100644
--- a/modules-available/locationinfo/inc/coursebackend.inc.php
+++ b/modules-available/locationinfo/inc/coursebackend.inc.php
@@ -39,7 +39,7 @@ abstract class CourseBackend
 		$this->errors = [];
 	}
 
-	protected final function addError($message, $fatal)
+	protected final function addError(string $message, bool $fatal)
 	{
 		$this->errors[] = ['time' => time(), 'message' => $message, 'fatal' => $fatal];
 	}
@@ -55,7 +55,7 @@ abstract class CourseBackend
 		self::$backendTypes = array();
 		foreach (glob(dirname(__FILE__) . '/coursebackend/coursebackend_*.inc.php', GLOB_NOSORT) as $file) {
 			require_once $file;
-			preg_match('#coursebackend_([^/\.]+)\.inc\.php$#i', $file, $out);
+			preg_match('#coursebackend_([^/.]+)\.inc\.php$#i', $file, $out);
 			$className = 'CourseBackend_' . $out[1];
 			if (!class_exists($className)) {
 				trigger_error("Backend type source unit $file doesn't seem to define class $className", E_USER_ERROR);
@@ -71,13 +71,13 @@ abstract class CourseBackend
 	 *
 	 * @return array list of backends
 	 */
-	public static function getList()
+	public static function getList(): array
 	{
 		self::loadDb();
 		return array_keys(self::$backendTypes);
 	}
 
-	public static function exists($backendType)
+	public static function exists($backendType): bool
 	{
 		self::loadDb();
 		return isset(self::$backendTypes[$backendType]);
@@ -89,7 +89,7 @@ abstract class CourseBackend
 	 * @param string $backendType name of module type
 	 * @return \CourseBackend|false module instance
 	 */
-	public static function getInstance($backendType)
+	public static function getInstance(string $backendType)
 	{
 		self::loadDb();
 		if (!isset(self::$backendTypes[$backendType])) {
@@ -106,18 +106,18 @@ abstract class CourseBackend
 	/**
 	 * @return string return display name of backend
 	 */
-	public abstract function getDisplayName();
+	public abstract function getDisplayName(): string;
 
 
 	/**
 	 * @returns \BackendProperty[] list of properties that need to be set
 	 */
-	public abstract function getCredentialDefinitions();
+	public abstract function getCredentialDefinitions(): array;
 
 	/**
 	 * @return boolean true if the connection works, false otherwise
 	 */
-	public abstract function checkConnection();
+	public abstract function checkConnection(): bool;
 
 	/**
 	 * uses json to setCredentials, the json must follow the form given in
@@ -126,42 +126,43 @@ abstract class CourseBackend
 	 * @param array $data assoc array with data required by backend
 	 * @returns bool if the credentials were in the correct format
 	 */
-	public abstract function setCredentialsInternal($data);
+	public abstract function setCredentialsInternal(array $data): bool;
 
 	/**
 	 * @return int desired caching time of results, in seconds. 0 = no caching
 	 */
-	public abstract function getCacheTime();
+	public abstract function getCacheTime(): int;
 
 	/**
 	 * @return int age after which timetables are no longer refreshed should be
 	 * greater then CacheTime
 	 */
-	public abstract function getRefreshTime();
+	public abstract function getRefreshTime(): int;
 
 	/**
 	 * Internal version of fetch, to be overridden by subclasses.
 	 *
-	 * @param $roomIds array with remote IDs for wanted rooms
+	 * @param $requestedRoomIds array with remote IDs for wanted rooms
 	 * @return array a recursive array that uses the roomID as key
 	 * and has the schedule array as value. A schedule array contains an array in this format:
 	 * ["start"=>'JJJJ-MM-DD"T"HH:MM:SS',"end"=>'JJJJ-MM-DD"T"HH:MM:SS',"title"=>string]
 	 */
-	protected abstract function fetchSchedulesInternal($roomId);
+	protected abstract function fetchSchedulesInternal(array $requestedRoomIds): array;
 
 	/**
 	 * In case you want to sanitize or otherwise mangle a property for your backend,
 	 * override this.
+	 *
 	 * @param string $prop
 	 * @param $value
 	 * @return mixed
 	 */
-	public function mangleProperty($prop, $value)
+	public function mangleProperty(string $prop, $value)
 	{
 		return $value;
 	}
 
-	private static function fixTime(&$start, &$end)
+	private static function fixTime(string &$start, string &$end): bool
 	{
 		if (!preg_match('/^(\d{2}|\d{4})-?\d{2}-?\d{2}-?T\d{1,2}:?\d{2}:?(\d{2})?$/', $start))
 			return false;
@@ -180,12 +181,8 @@ abstract class CourseBackend
 	 * @param array $requestedLocationIds array of room ID to fetch
 	 * @return array|bool array containing the timetables as value and roomid as key as result, or false on error
 	 */
-	public final function fetchSchedule($requestedLocationIds)
+	public final function fetchSchedule(array $requestedLocationIds)
 	{
-		if (!is_array($requestedLocationIds)) {
-			$this->addError('No array of roomids was given to fetchSchedule', false);
-			return false;
-		}
 		if (empty($requestedLocationIds))
 			return array();
 		$requestedLocationIds = array_values($requestedLocationIds);
@@ -282,7 +279,7 @@ abstract class CourseBackend
 		return $returnValue;
 	}
 
-	public final function setCredentials($serverId, $data)
+	public final function setCredentials(int $serverId, array $data): bool
 	{
 		foreach ($this->getCredentialDefinitions() as $prop) {
 			if (!isset($data[$prop->property])) {
@@ -302,18 +299,9 @@ abstract class CourseBackend
 	}
 
 	/**
-	 * @return false if there was no error string with error message if there was one
-	 */
-	public final function getError()
-	{
-		trigger_error('getError() is legacy; use getErrors()');
-		return $this->error;
-	}
-
-	/**
 	 * @return array list of errors that occurred during processing.
 	 */
-	public final function getErrors()
+	public final function getErrors(): array
 	{
 		return $this->errors;
 	}
@@ -378,7 +366,7 @@ abstract class CourseBackend
 	 * @param string $response xml document to convert
 	 * @return bool|array array representation of the xml if possible, false otherwise
 	 */
-	protected function xmlStringToArray($response, &$error)
+	protected function xmlStringToArray(string $response, &$error)
 	{
 		$cleanresponse = preg_replace('/(<\/?)(\w+):([^>]*>)/', '$1$2$3', $response);
 		try {
@@ -414,7 +402,6 @@ class BackendProperty {
 	 * Initialize additional fields of this class that are only required
 	 * for rendering the server configuration dialog.
 	 *
-	 * @param string $backendId target backend id
 	 * @param mixed $current current value of this property.
 	 */
 	public function initForRender($current = null) {
diff --git a/modules-available/locationinfo/inc/coursebackend/coursebackend_davinci.inc.php b/modules-available/locationinfo/inc/coursebackend/coursebackend_davinci.inc.php
index 07c8457d..f03444c2 100644
--- a/modules-available/locationinfo/inc/coursebackend/coursebackend_davinci.inc.php
+++ b/modules-available/locationinfo/inc/coursebackend/coursebackend_davinci.inc.php
@@ -11,7 +11,7 @@ class CourseBackend_Davinci extends CourseBackend
 	 */
 	private $curlHandle = false;
 
-	public function setCredentialsInternal($data)
+	public function setCredentialsInternal(array $data): bool
 	{
 		if (empty($data['baseUrl'])) {
 			$this->addError("No url is given", true);
@@ -24,7 +24,7 @@ class CourseBackend_Davinci extends CourseBackend
 		return true;
 	}
 
-	public function checkConnection()
+	public function checkConnection(): bool
 	{
 		if (empty($this->location)) {
 			$this->addError("Credentials are not set", true);
@@ -40,7 +40,7 @@ class CourseBackend_Davinci extends CourseBackend
 		return true;
 	}
 
-	public function getCredentialDefinitions()
+	public function getCredentialDefinitions(): array
 	{
 		return [
 			new BackendProperty('baseUrl', 'string'),
@@ -49,17 +49,17 @@ class CourseBackend_Davinci extends CourseBackend
 		];
 	}
 
-	public function getDisplayName()
+	public function getDisplayName(): string
 	{
 		return 'Davinci';
 	}
 
-	public function getCacheTime()
+	public function getCacheTime(): int
 	{
 		return 30 * 60;
 	}
 
-	public function getRefreshTime()
+	public function getRefreshTime(): int
 	{
 		return 0;
 	}
@@ -68,9 +68,9 @@ class CourseBackend_Davinci extends CourseBackend
 	 * @param string $roomId unique name of the room, as used by davinci
 	 * @param \DateTime $startDate start date to fetch
 	 * @param \DateTime $endDate end date of range to fetch
-	 * @return array|bool if successful the arrayrepresentation of the timetable
+	 * @return array|bool if successful the array representation of the timetable
 	 */
-	private function fetchRoomRaw($roomId, $startDate, $endDate)
+	private function fetchRoomRaw(string $roomId, DateTime $startDate, DateTime $endDate)
 	{
 		$url = $this->location . "content=xml&type=room&name=" . urlencode($roomId)
 			. "&startdate=" . $startDate->format('d.m.Y') . "&enddate=" . $endDate->format('d.m.Y');
@@ -97,7 +97,7 @@ class CourseBackend_Davinci extends CourseBackend
 
 	}
 
-	public function fetchSchedulesInternal($requestedRoomIds)
+	public function fetchSchedulesInternal(array $requestedRoomIds): array
 	{
 		$startDate = new DateTime('last Monday 0:00');
 		$endDate = new DateTime('+14 days 0:00');
@@ -134,7 +134,7 @@ class CourseBackend_Davinci extends CourseBackend
 				$start = substr($start, 0, 2) . ':' . substr($start, 2, 2);
 				$end = $lesson['Finish'];
 				$end = substr($end, 0, 2) . ':' . substr($end, 2, 2);
-				$subject = isset($lesson['Subject']) ? $lesson['Subject'] : '???';
+				$subject = $lesson['Subject'] ?? '???';
 				$timetable[] = array(
 					'title' => $subject,
 					'start' => $date . "T" . $start . ':00',
diff --git a/modules-available/locationinfo/inc/coursebackend/coursebackend_dummy.inc.php b/modules-available/locationinfo/inc/coursebackend/coursebackend_dummy.inc.php
index 2cb2be18..4588bf7c 100644
--- a/modules-available/locationinfo/inc/coursebackend/coursebackend_dummy.inc.php
+++ b/modules-available/locationinfo/inc/coursebackend/coursebackend_dummy.inc.php
@@ -15,9 +15,9 @@ class CourseBackend_Dummy extends CourseBackend
 	 * @param int $serverId ID of the server
 	 * @returns bool if the credentials were in the correct format
 	 */
-	public function setCredentialsInternal($json)
+	public function setCredentialsInternal(array $data): bool
 	{
-		$x = $json;
+		$x = $data;
 		$this->pw = $x['password'];
 
 		if ($this->pw === "mfg") {
@@ -30,7 +30,7 @@ class CourseBackend_Dummy extends CourseBackend
 	/**
 	 * @return boolean true if the connection works, false otherwise
 	 */
-	public function checkConnection()
+	public function checkConnection(): bool
 	{
 		if ($this->pw == "mfg") {
 			return true;
@@ -42,7 +42,7 @@ class CourseBackend_Dummy extends CourseBackend
 	/**
 	 * @returns array with parameter name as key and and an array with type, help text and mask  as value
 	 */
-	public function getCredentialDefinitions()
+	public function getCredentialDefinitions(): array
 	{
 		$options = ["opt1", "opt2", "opt3", "opt4", "opt5", "opt6", "opt7", "opt8"];
 		return [
@@ -58,7 +58,7 @@ class CourseBackend_Dummy extends CourseBackend
 	/**
 	 * @return string return display name of backend
 	 */
-	public function getDisplayName()
+	public function getDisplayName(): string
 	{
 		return 'Dummy with array';
 	}
@@ -66,7 +66,7 @@ class CourseBackend_Dummy extends CourseBackend
 	/**
 	 * @return int desired caching time of results, in seconds. 0 = no caching
 	 */
-	public function getCacheTime()
+	public function getCacheTime(): int
 	{
 		return 0;
 	}
@@ -75,7 +75,7 @@ class CourseBackend_Dummy extends CourseBackend
 	 * @return int age after which timetables are no longer refreshed should be
 	 * greater then CacheTime
 	 */
-	public function getRefreshTime()
+	public function getRefreshTime(): int
 	{
 		return 0;
 	}
@@ -83,15 +83,15 @@ class CourseBackend_Dummy extends CourseBackend
 	/**
 	 * Internal version of fetch, to be overridden by subclasses.
 	 *
-	 * @param $roomIds array with local ID as key and serverId as value
+	 * @param $requestedRoomIds array with local ID as key and serverId as value
 	 * @return array a recursive array that uses the roomID as key
 	 * and has the schedule array as value. A schedule array contains an array in this format:
 	 * ["start"=>'YYYY-MM-DD<T>HH:MM:SS',"end"=>'YYYY-MM-DD<T>HH:MM:SS',"title"=>string]
 	 */
-	public function fetchSchedulesInternal($roomId)
+	public function fetchSchedulesInternal(array $requestedRoomIds): array
 	{
 		$a = array();
-		foreach ($roomId as $id) {
+		foreach ($requestedRoomIds as $id) {
 			if ($id == 1) {
 				$now = time();
 				return array($id => array(
diff --git a/modules-available/locationinfo/inc/coursebackend/coursebackend_exchange.inc.php b/modules-available/locationinfo/inc/coursebackend/coursebackend_exchange.inc.php
index 44847ce2..a0eca0ec 100755
--- a/modules-available/locationinfo/inc/coursebackend/coursebackend_exchange.inc.php
+++ b/modules-available/locationinfo/inc/coursebackend/coursebackend_exchange.inc.php
@@ -38,7 +38,7 @@ class CourseBackend_Exchange extends CourseBackend
 	/**
 	 * @return string return display name of backend
 	 */
-	public function getDisplayName()
+	public function getDisplayName(): string
 	{
 		return "Microsoft Exchange";
 	}
@@ -46,7 +46,7 @@ class CourseBackend_Exchange extends CourseBackend
 	/**
 	 * @returns \BackendProperty[] list of properties that need to be set
 	 */
-	public function getCredentialDefinitions()
+	public function getCredentialDefinitions(): array
 	{
 		$options = [
 			Client::VERSION_2007,
@@ -72,7 +72,7 @@ class CourseBackend_Exchange extends CourseBackend
 	/**
 	 * @return boolean true if the connection works, false otherwise
 	 */
-	public function checkConnection()
+	public function checkConnection(): bool
 	{
 		$client = $this->getClient();
 		$request = new ResolveNamesType();
@@ -104,7 +104,7 @@ class CourseBackend_Exchange extends CourseBackend
 	 * @param array $data assoc array with data required by backend
 	 * @returns bool if the credentials were in the correct format
 	 */
-	public function setCredentialsInternal($data)
+	public function setCredentialsInternal(array $data): bool
 	{
 		foreach (['username', 'password'] as $field) {
 			if (empty($data[$field])) {
@@ -133,7 +133,7 @@ class CourseBackend_Exchange extends CourseBackend
 	/**
 	 * @return int desired caching time of results, in seconds. 0 = no caching
 	 */
-	public function getCacheTime()
+	public function getCacheTime(): int
 	{
 		return 15 * 60;
 	}
@@ -142,7 +142,7 @@ class CourseBackend_Exchange extends CourseBackend
 	 * @return int age after which timetables are no longer refreshed. should be
 	 * greater than CacheTime.
 	 */
-	public function getRefreshTime()
+	public function getRefreshTime(): int
 	{
 		return 30 * 60;
 	}
@@ -150,12 +150,12 @@ class CourseBackend_Exchange extends CourseBackend
 	/**
 	 * Internal version of fetch, to be overridden by subclasses.
 	 *
-	 * @param $roomIds array with local ID as key and serverId as value
+	 * @param $requestedRoomIds array with local ID as key and serverId as value
 	 * @return array a recursive array that uses the roomID as key
 	 * and has the schedule array as value. A schedule array contains an array in this format:
 	 * ["start"=>'JJJJ-MM-DD HH:MM:SS',"end"=>'JJJJ-MM-DD HH:MM:SS',"title"=>string]
 	 */
-	protected function fetchSchedulesInternal($requestedRoomIds)
+	protected function fetchSchedulesInternal(array $requestedRoomIds): array
 	{
 		$startDate = new DateTime('last Monday 0:00');
 		$endDate = new DateTime('+14 days 0:00');
diff --git a/modules-available/locationinfo/inc/coursebackend/coursebackend_hisinone.inc.php b/modules-available/locationinfo/inc/coursebackend/coursebackend_hisinone.inc.php
index cccbef91..4d70e5aa 100644
--- a/modules-available/locationinfo/inc/coursebackend/coursebackend_hisinone.inc.php
+++ b/modules-available/locationinfo/inc/coursebackend/coursebackend_hisinone.inc.php
@@ -3,7 +3,7 @@
 class CourseBackend_HisInOne extends ICalCourseBackend
 {
 
-	public function setCredentialsInternal($data)
+	public function setCredentialsInternal(array $data): bool
 	{
 		if (empty($data['baseUrl'])) {
 			$this->addError("No url is given", true);
@@ -16,7 +16,7 @@ class CourseBackend_HisInOne extends ICalCourseBackend
 		return true;
 	}
 
-	public function getCredentialDefinitions()
+	public function getCredentialDefinitions(): array
 	{
 		return [
 			new BackendProperty('baseUrl', 'string'),
@@ -25,7 +25,7 @@ class CourseBackend_HisInOne extends ICalCourseBackend
 		];
 	}
 
-	public function mangleProperty($prop, $value)
+	public function mangleProperty(string $prop, $value)
 	{
 		if ($prop === 'baseUrl') {
 			// Update form SOAP to iCal url
@@ -52,7 +52,7 @@ class CourseBackend_HisInOne extends ICalCourseBackend
 		return $title;
 	}
 
-	public function checkConnection()
+	public function checkConnection(): bool
 	{
 		if (!$this->isOK())
 			return false;
@@ -66,18 +66,18 @@ class CourseBackend_HisInOne extends ICalCourseBackend
 		return false;
 	}
 
-	public function getCacheTime()
+	public function getCacheTime(): int
 	{
 		return 30 * 60;
 	}
 
-	public function getRefreshTime()
+	public function getRefreshTime(): int
 	{
 		return 60 * 60;
 	}
 
 
-	public function getDisplayName()
+	public function getDisplayName(): string
 	{
 		return "HisInOne";
 	}
diff --git a/modules-available/locationinfo/inc/coursebackend/coursebackend_ical.inc.php b/modules-available/locationinfo/inc/coursebackend/coursebackend_ical.inc.php
index 98dca1cb..f1791c4e 100644
--- a/modules-available/locationinfo/inc/coursebackend/coursebackend_ical.inc.php
+++ b/modules-available/locationinfo/inc/coursebackend/coursebackend_ical.inc.php
@@ -6,7 +6,7 @@ class CourseBackend_ICal extends ICalCourseBackend
 	/** @var string room ID for testing connection */
 	private $testId;
 
-	public function setCredentialsInternal($data)
+	public function setCredentialsInternal(array $data): bool
 	{
 		if (empty($data['baseUrl'])) {
 			$this->addError("No url is given", true);
@@ -20,7 +20,7 @@ class CourseBackend_ICal extends ICalCourseBackend
 		return true;
 	}
 
-	public function getCredentialDefinitions()
+	public function getCredentialDefinitions(): array
 	{
 		return [
 			new BackendProperty('baseUrl', 'string'),
@@ -33,7 +33,7 @@ class CourseBackend_ICal extends ICalCourseBackend
 		];
 	}
 
-	public function checkConnection()
+	public function checkConnection(): bool
 	{
 		if (!$this->isOK())
 			return false;
@@ -42,18 +42,18 @@ class CourseBackend_ICal extends ICalCourseBackend
 		return ($this->downloadIcal($this->testId) !== null);
 	}
 
-	public function getCacheTime()
+	public function getCacheTime(): int
 	{
 		return 30 * 60;
 	}
 
-	public function getRefreshTime()
+	public function getRefreshTime(): int
 	{
 		return 60 * 60;
 	}
 
 
-	public function getDisplayName()
+	public function getDisplayName(): string
 	{
 		return "iCal";
 	}
diff --git a/modules-available/locationinfo/inc/icalcoursebackend.inc.php b/modules-available/locationinfo/inc/icalcoursebackend.inc.php
index c1791919..50f1881a 100644
--- a/modules-available/locationinfo/inc/icalcoursebackend.inc.php
+++ b/modules-available/locationinfo/inc/icalcoursebackend.inc.php
@@ -28,8 +28,9 @@ abstract class ICalCourseBackend extends CourseBackend
 	 * @param string $user
 	 * @param string $pass
 	 */
-	protected function init($location, $verifyCert, $verifyHostname,
-		$authMethod = 'NONE', $user = '', $pass = '')
+	protected function init(
+		string $location, bool $verifyCert, bool $verifyHostname,
+		string $authMethod = 'NONE', string $user = '', string $pass = '')
 	{
 		$this->verifyCert = $verifyCert;
 		$this->verifyHostname = $verifyHostname;
@@ -92,7 +93,7 @@ abstract class ICalCourseBackend extends CourseBackend
 		return $ical->events();
 	}
 
-	public function fetchSchedulesInternal($requestedRoomIds): array
+	public function fetchSchedulesInternal(array $requestedRoomIds): array
 	{
 		if (empty($requestedRoomIds) || !$this->isOK()) {
 			return array();
diff --git a/modules-available/locationinfo/page.inc.php b/modules-available/locationinfo/page.inc.php
index 440a115d..de21aae2 100644
--- a/modules-available/locationinfo/page.inc.php
+++ b/modules-available/locationinfo/page.inc.php
@@ -438,7 +438,8 @@ class Page_LocationInfo extends Page
 			LocationInfo::setServerError($serverid, 'Unknown backend type: ' . $dbresult['servertype']);
 			return;
 		}
-		$credentialsOk = $serverInstance->setCredentials($serverid, json_decode($dbresult['credentials'], true));
+		$credentialsOk = $serverInstance->setCredentials($serverid,
+			(array)json_decode($dbresult['credentials'], true));
 
 		if ($credentialsOk) {
 			$serverInstance->checkConnection();