refactor(urlgenerator): Move getLogoutUrl from OC_User to IUrlGenerator

refactor(urlgenerator): Move getLogoutUrl from OC_User to IUrlGenerator

And some minor cleanup of both IApacheBackend and UrlGenerator to

properly type non-empty-string

Signed-off-by: Carl Schwan <carlschwan@kde.org>

[skip ci]

Author: CarlSchwan

lib/private/URLGenerator.php

@@ -9,14 +9,18 @@
 namespace OC;
 
 use OC\Route\Router;
+use OC\Security\CSRF\CsrfTokenManager;
 use OCA\Theming\ThemingDefaults;
 use OCP\App\AppPathNotFoundException;
 use OCP\App\IAppManager;
+use OCP\Authentication\IApacheBackend;
 use OCP\ICacheFactory;
 use OCP\IConfig;
 use OCP\INavigationManager;
 use OCP\IRequest;
 use OCP\IURLGenerator;
+use OCP\IUser;
+use OCP\IUserManager;
 use OCP\IUserSession;
 use RuntimeException;
 

lib/public/Authentication/IApacheBackend.php

@@ -19,23 +19,23 @@ interface IApacheBackend {
 	/**
 	 * In case the user has been authenticated by a module true is returned.
 	 *
-	 * @return boolean whether the module reports a user as currently logged in.
+	 * @return bool whether the module reports a user as currently logged in.
 	 * @since 6.0.0
 	 */
-	public function isSessionActive();
+	public function isSessionActive(): bool;
 
 	/**
 	 * Gets the current logout URL
 	 *
-	 * @return string
+	 * @return non-empty-string
 	 * @since 12.0.3
 	 */
-	public function getLogoutUrl();
+	public function getLogoutUrl(): string;
 
 	/**
 	 * Return the id of the current user
 	 * @return string
 	 * @since 6.0.0
 	 */
-	public function getCurrentUserId();
+	public function getCurrentUserId(): string;
 }

lib/public/IURLGenerator.php

@@ -35,7 +35,7 @@ interface IURLGenerator {
 
 	/**
 	 * Returns the URL for a route
-	 * @param string $routeName the name of the route
+	 * @param non-empty-string $routeName the name of the route
 	 * @param array $arguments an array with arguments which will be filled into the url
 	 * @return string the url
 	 * @since 6.0.0
@@ -44,9 +44,9 @@ public function linkToRoute(string $routeName, array $arguments = []): string;
 
 	/**
 	 * Returns the absolute URL for a route
-	 * @param string $routeName the name of the route
+	 * @param non-empty-string $routeName the name of the route
 	 * @param array $arguments an array with arguments which will be filled into the url
-	 * @return string the absolute url
+	 * @return non-empty-string the absolute url
 	 * @since 8.0.0
 	 */
 	public function linkToRouteAbsolute(string $routeName, array $arguments = []): string;
@@ -60,7 +60,7 @@ public function linkToRouteAbsolute(string $routeName, array $arguments = []): s
 	public function linkToOCSRouteAbsolute(string $routeName, array $arguments = []): string;
 
 	/**
-	 * Returns an URL for an image or file
+	 * Returns a URL for an image or file
 	 * @param string $appName the name of the app
 	 * @param string $file the name of the file
 	 * @param array $args array with param=>value, will be appended to the returned url
@@ -82,9 +82,9 @@ public function imagePath(string $appName, string $file): string;
 
 
 	/**
-	 * Makes an URL absolute
+	 * Makes a URL absolute
 	 * @param string $url the url in the ownCloud host
-	 * @return string the absolute version of the url
+	 * @return non-empty-string the absolute version of the url
 	 * @since 6.0.0
 	 */
 	public function getAbsoluteURL(string $url): string;
@@ -105,7 +105,7 @@ public function linkToDocs(string $key): string;
 	public function linkToDefaultPageUrl(): string;
 
 	/**
-	 * @return string base url of the current request
+	 * @return non-empty-string base url of the current request
 	 * @since 13.0.0
 	 */
 	public function getBaseUrl(): string;