1 files changed, 47 insertions, 60 deletions

diff --git a/apps/weather_status/lib/Controller/WeatherStatusController.php b/apps/weather_status/lib/Controller/WeatherStatusController.php
index 01bdf78f410..c56ea3b97b3 100644
--- a/apps/weather_status/lib/Controller/WeatherStatusController.php
+++ b/apps/weather_status/lib/Controller/WeatherStatusController.php
@@ -3,117 +3,102 @@
 declare(strict_types=1);
 
 /**
- * @copyright Copyright (c) 2020, Julien Veyssier
- *
- * @author Julien Veyssier <eneiluj@posteo.net>
- *
- * @license GNU AGPL version 3 or any later version
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- *
+ * SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 namespace OCA\WeatherStatus\Controller;
 
+use OCA\WeatherStatus\ResponseDefinitions;
 use OCA\WeatherStatus\Service\WeatherStatusService;
 use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Attribute\NoAdminRequired;
 use OCP\AppFramework\Http\DataResponse;
 use OCP\AppFramework\OCSController;
-use OCP\ILogger;
 use OCP\IRequest;
 
+/**
+ * @psalm-import-type WeatherStatusForecast from ResponseDefinitions
+ * @psalm-import-type WeatherStatusSuccess from ResponseDefinitions
+ * @psalm-import-type WeatherStatusLocation from ResponseDefinitions
+ * @psalm-import-type WeatherStatusLocationWithSuccess from ResponseDefinitions
+ * @psalm-import-type WeatherStatusLocationWithMode from ResponseDefinitions
+ */
 class WeatherStatusController extends OCSController {
-
-	/** @var string */
-	private $userId;
-
-	/** @var ILogger */
-	private $logger;
-
-	/** @var WeatherStatusService */
-	private $service;
-
-	public function __construct(string $appName,
-								IRequest $request,
-								ILogger $logger,
-								WeatherStatusService $service,
-								?string $userId) {
+	public function __construct(
+		string $appName,
+		IRequest $request,
+		private WeatherStatusService $service,
+		private ?string $userId,
+	) {
 		parent::__construct($appName, $request);
-		$this->userId = $userId;
-		$this->logger = $logger;
-		$this->service = $service;
 	}
 
 	/**
-	 * @NoAdminRequired
-	 *
 	 * Try to use the address set in user personal settings as weather location
 	 *
-	 * @return DataResponse with success state and address information
+	 * @return DataResponse<Http::STATUS_OK, WeatherStatusLocationWithSuccess, array{}>
+	 *
+	 * 200: Address updated
 	 */
+	#[NoAdminRequired]
 	public function usePersonalAddress(): DataResponse {
 		return new DataResponse($this->service->usePersonalAddress());
 	}
 
 	/**
-	 * @NoAdminRequired
-	 *
 	 * Change the weather status mode. There are currently 2 modes:
 	 * - ask the browser
 	 * - use the user defined address
 	 *
 	 * @param int $mode New mode
-	 * @return DataResponse success state
+	 * @return DataResponse<Http::STATUS_OK, WeatherStatusSuccess, array{}>
+	 *
+	 * 200: Weather status mode updated
 	 */
+	#[NoAdminRequired]
 	public function setMode(int $mode): DataResponse {
 		return new DataResponse($this->service->setMode($mode));
 	}
 
 	/**
-	 * @NoAdminRequired
-	 *
 	 * Set address and resolve it to get coordinates
 	 * or directly set coordinates and get address with reverse geocoding
 	 *
 	 * @param string|null $address Any approximative or exact address
 	 * @param float|null $lat Latitude in decimal degree format
 	 * @param float|null $lon Longitude in decimal degree format
-	 * @return DataResponse with success state and address information
+	 * @return DataResponse<Http::STATUS_OK, WeatherStatusLocationWithSuccess, array{}>
+	 *
+	 * 200: Location updated
 	 */
+	#[NoAdminRequired]
 	public function setLocation(?string $address, ?float $lat, ?float $lon): DataResponse {
 		$currentWeather = $this->service->setLocation($address, $lat, $lon);
 		return new DataResponse($currentWeather);
 	}
 
 	/**
-	 * @NoAdminRequired
-	 *
 	 * Get stored user location
 	 *
-	 * @return DataResponse which contains coordinates, formatted address and current weather status mode
+	 * @return DataResponse<Http::STATUS_OK, WeatherStatusLocationWithMode, array{}>
+	 *
+	 * 200: Location returned
 	 */
+	#[NoAdminRequired]
 	public function getLocation(): DataResponse {
 		$location = $this->service->getLocation();
 		return new DataResponse($location);
 	}
 
 	/**
-	 * @NoAdminRequired
-	 *
 	 * Get forecast for current location
 	 *
-	 * @return DataResponse which contains success state and filtered forecast data
+	 * @return DataResponse<Http::STATUS_OK, list<WeatherStatusForecast>|array{error: string}, array{}>|DataResponse<Http::STATUS_NOT_FOUND, WeatherStatusSuccess, array{}>
+	 *
+	 * 200: Forecast returned
+	 * 404: Forecast not found
 	 */
+	#[NoAdminRequired]
 	public function getForecast(): DataResponse {
 		$forecast = $this->service->getForecast();
 		if (isset($forecast['success']) && $forecast['success'] === false) {
@@ -124,24 +109,26 @@ class WeatherStatusController extends OCSController {
 	}
 
 	/**
-	 * @NoAdminRequired
-	 *
 	 * Get favorites list
 	 *
-	 * @return DataResponse which contains the favorite list
+	 * @return DataResponse<Http::STATUS_OK, list<string>, array{}>
+	 *
+	 * 200: Favorites returned
 	 */
+	#[NoAdminRequired]
 	public function getFavorites(): DataResponse {
 		return new DataResponse($this->service->getFavorites());
 	}
 
 	/**
-	 * @NoAdminRequired
-	 *
 	 * Set favorites list
 	 *
-	 * @param array $favorites
-	 * @return DataResponse success state
+	 * @param list<string> $favorites Favorite addresses
+	 * @return DataResponse<Http::STATUS_OK, WeatherStatusSuccess, array{}>
+	 *
+	 * 200: Favorites updated
 	 */
+	#[NoAdminRequired]
 	public function setFavorites(array $favorites): DataResponse {
 		return new DataResponse($this->service->setFavorites($favorites));
 	}