diff options
Diffstat (limited to 'apps/weather_status/lib/Controller/WeatherStatusController.php')
-rw-r--r-- | apps/weather_status/lib/Controller/WeatherStatusController.php | 135 |
1 files changed, 135 insertions, 0 deletions
diff --git a/apps/weather_status/lib/Controller/WeatherStatusController.php b/apps/weather_status/lib/Controller/WeatherStatusController.php new file mode 100644 index 00000000000..c56ea3b97b3 --- /dev/null +++ b/apps/weather_status/lib/Controller/WeatherStatusController.php @@ -0,0 +1,135 @@ +<?php + +declare(strict_types=1); + +/** + * 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\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 { + public function __construct( + string $appName, + IRequest $request, + private WeatherStatusService $service, + private ?string $userId, + ) { + parent::__construct($appName, $request); + } + + /** + * Try to use the address set in user personal settings as weather location + * + * @return DataResponse<Http::STATUS_OK, WeatherStatusLocationWithSuccess, array{}> + * + * 200: Address updated + */ + #[NoAdminRequired] + public function usePersonalAddress(): DataResponse { + return new DataResponse($this->service->usePersonalAddress()); + } + + /** + * 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<Http::STATUS_OK, WeatherStatusSuccess, array{}> + * + * 200: Weather status mode updated + */ + #[NoAdminRequired] + public function setMode(int $mode): DataResponse { + return new DataResponse($this->service->setMode($mode)); + } + + /** + * 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<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); + } + + /** + * Get stored user location + * + * @return DataResponse<Http::STATUS_OK, WeatherStatusLocationWithMode, array{}> + * + * 200: Location returned + */ + #[NoAdminRequired] + public function getLocation(): DataResponse { + $location = $this->service->getLocation(); + return new DataResponse($location); + } + + /** + * Get forecast for current location + * + * @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) { + return new DataResponse($forecast, Http::STATUS_NOT_FOUND); + } else { + return new DataResponse($forecast); + } + } + + /** + * Get favorites list + * + * @return DataResponse<Http::STATUS_OK, list<string>, array{}> + * + * 200: Favorites returned + */ + #[NoAdminRequired] + public function getFavorites(): DataResponse { + return new DataResponse($this->service->getFavorites()); + } + + /** + * Set favorites list + * + * @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)); + } +} |