Add proper types to various RouteHandler symbols
authorTim Düsterhus <duesterhus@woltlab.com>
Fri, 14 Apr 2023 13:20:32 +0000 (15:20 +0200)
committerTim Düsterhus <duesterhus@woltlab.com>
Fri, 14 Apr 2023 13:20:32 +0000 (15:20 +0200)
wcfsetup/install/files/lib/system/request/RouteHandler.class.php

index 1ee730696d3686627b1845a51371a56d8548532e..f4ba8ce1977b1a3ccdddd750d58e3029007a45a3 100644 (file)
@@ -54,21 +54,19 @@ final class RouteHandler extends SingletonFactory
 
     /**
      * true if the default controller is used (support for custom landing page)
-     * @var bool
      */
-    private $isDefaultController = false;
+    private bool $isDefaultController = false;
 
     /**
      * true if the controller was renamed and has already been transformed
-     * @var bool
      */
-    private $isRenamedController = false;
+    private bool $isRenamedController = false;
 
     /**
      * list of available routes
      * @var IRequestRoute[]
      */
-    private $routes = [];
+    private array $routes = [];
 
     /**
      * parsed route data
@@ -119,10 +117,8 @@ final class RouteHandler extends SingletonFactory
      * Returns true if a route matches. Please bear in mind, that the
      * first route that is able to consume all path components is used,
      * even if other routes may fit better. Route order is crucial!
-     *
-     * @return  bool
      */
-    public function matches()
+    public function matches(): bool
     {
         foreach ($this->routes as $route) {
             if (RequestHandler::getInstance()->isACPRequest() != $route->isACP()) {
@@ -162,20 +158,16 @@ final class RouteHandler extends SingletonFactory
 
     /**
      * Returns true if route uses default controller.
-     *
-     * @return  bool
      */
-    public function isDefaultController()
+    public function isDefaultController(): bool
     {
         return $this->isDefaultController;
     }
 
     /**
      * Returns true if the controller was renamed and has already been transformed.
-     *
-     * @return      bool
      */
-    public function isRenamedController()
+    public function isRenamedController(): bool
     {
         return $this->isRenamedController;
     }
@@ -193,7 +185,7 @@ final class RouteHandler extends SingletonFactory
     /**
      * Registers route data within $_GET and $_REQUEST.
      */
-    private function registerRouteData()
+    private function registerRouteData(): void
     {
         foreach ($this->routeData as $key => $value) {
             $_GET[$key] = $value;
@@ -246,17 +238,15 @@ final class RouteHandler extends SingletonFactory
      * @return  bool    true if `$customUrl` passes the sanity check
      * @since   3.0
      */
-    public static function isValidCustomUrl($customUrl)
+    public static function isValidCustomUrl($customUrl): bool
     {
         return \preg_match('~^[a-z0-9\-_/]+$~', $customUrl) === 1;
     }
 
     /**
      * Returns true if this is a secure connection.
-     *
-     * @return  bool
      */
-    public static function secureConnection()
+    public static function secureConnection(): bool
     {
         if (self::$secure === null) {
             self::$secure = false;
@@ -275,10 +265,8 @@ final class RouteHandler extends SingletonFactory
 
     /**
      * Returns HTTP protocol, either 'http://' or 'https://'.
-     *
-     * @return  string
      */
-    public static function getProtocol()
+    public static function getProtocol(): string
     {
         if (empty(self::$protocol)) {
             self::$protocol = 'http' . (self::secureConnection() ? 's' : '') . '://';
@@ -289,10 +277,8 @@ final class RouteHandler extends SingletonFactory
 
     /**
      * Returns protocol and domain name.
-     *
-     * @return  string
      */
-    public static function getHost()
+    public static function getHost(): string
     {
         if (empty(self::$host)) {
             self::$host = self::getProtocol() . $_SERVER['HTTP_HOST'];
@@ -303,11 +289,8 @@ final class RouteHandler extends SingletonFactory
 
     /**
      * Returns absolute domain path.
-     *
-     * @param array $removeComponents
-     * @return  string
      */
-    public static function getPath(array $removeComponents = [])
+    public static function getPath(array $removeComponents = []): string
     {
         if (empty(self::$path)) {
             // dirname return a single backslash on Windows if there are no parent directories
@@ -335,10 +318,8 @@ final class RouteHandler extends SingletonFactory
 
     /**
      * Returns current path info component.
-     *
-     * @return  string
      */
-    public static function getPathInfo()
+    public static function getPathInfo(): string
     {
         if (self::$pathInfo === null) {
             self::$pathInfo = '';