Updated phpDoc
authorAlexander Ebert <ebert@woltlab.com>
Wed, 18 Nov 2015 09:51:31 +0000 (10:51 +0100)
committerAlexander Ebert <ebert@woltlab.com>
Wed, 18 Nov 2015 09:51:31 +0000 (10:51 +0100)
wcfsetup/install/files/lib/system/request/RouteHandler.class.php
wcfsetup/install/files/lib/system/request/route/DynamicRequestRoute.class.php

index 3f9090d5f73b30cca7b12e1b6d86a910acb80312..0a308b154aa5c83f8866789de6ba4f4d31c3fc5a 100644 (file)
@@ -108,7 +108,6 @@ class RouteHandler extends SingletonFactory {
         * Sets default routes.
         */
        public function setDefaultRoutes() {
-               /** @var \wcf\system\request\route\DynamicRequestRoute $route */
                $route = WCF::getDIContainer()->make(DynamicRequestRoute::class);
                $route->setIsACP(true);
                $this->addRoute($route);
index add7f76379318040daa1ebb55508bea7d76be939..389f37a475bf66f33782787993b283d0538799a7 100644 (file)
@@ -1,14 +1,23 @@
 <?php
 namespace wcf\system\request\route;
-
 use wcf\system\application\ApplicationHandler;
 use wcf\system\menu\page\PageMenu;
 use wcf\system\request\RequestHandler;
 use wcf\system\request\RouteHandler;
 
+/**
+ * Dynamic route implementation to resolve HTTP requests, handling controllers using a distinct pattern.
+ * 
+ * @author     Alexander Ebert
+ * @copyright  2001-2015 WoltLab GmbH
+ * @license    GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @package    com.woltlab.wcf
+ * @subpackage system.request
+ * @category   Community Framework
+ */
 class DynamicRequestRoute implements IRequestRoute {
        /**
-        * @var \wcf\system\application\ApplicationHandler
+        * @var ApplicationHandler
         */
        protected $applicationHandler;
        
@@ -25,7 +34,7 @@ class DynamicRequestRoute implements IRequestRoute {
        protected $isACP = false;
        
        /**
-        * @var \wcf\system\menu\page\PageMenu;
+        * @var PageMenu;
         */
        protected $pageMenu;
        
@@ -42,7 +51,7 @@ class DynamicRequestRoute implements IRequestRoute {
        protected $primaryApplication = '';
        
        /**
-        * @var \wcf\system\request\RequestHandler
+        * @var RequestHandler
         */
        protected $requestHandler;
        
@@ -59,17 +68,17 @@ class DynamicRequestRoute implements IRequestRoute {
        protected $routeData = [];
        
        /**
-        * @var \wcf\system\request\RouteHandler;
+        * @var RouteHandler;
         */
        protected $routeHandler;
        
        /**
         * DynamicRequestRoute constructor.
         * 
-        * @param       \wcf\system\application\ApplicationHandler      $applicationHandler
-        * @param       \wcf\system\menu\page\PageMenu                  $pageMenu
-        * @param       \wcf\system\request\RequestHandler              $requestHandler
-        * @param       \wcf\system\request\RouteHandler                $routeHandler
+        * @param       ApplicationHandler      $applicationHandler
+        * @param       PageMenu                $pageMenu
+        * @param       RequestHandler          $requestHandler
+        * @param       RouteHandler            $routeHandler
         */
        public function __construct(ApplicationHandler $applicationHandler, PageMenu $pageMenu, RequestHandler $requestHandler, RouteHandler $routeHandler) {
                $this->applicationHandler = $applicationHandler;
@@ -102,7 +111,7 @@ class DynamicRequestRoute implements IRequestRoute {
        }
        
        /**
-        * {@inheritdoc}
+        * @see IRequestRoute::setIsACP()
         */
        public function setIsACP($isACP) {
                $this->isACP = $isACP;