Implement feedback changes to App\Router

- Add class PhpDoc
- Switch Router->routeCollector scope to protected
- Added getter for Router->routeCollector
- Added EOF new line
- Removed unused use statement
- Improved App->collectRoutes PhpDoc
This commit is contained in:
Hypolite Petovan 2019-04-04 07:29:26 -04:00
parent 350d3b51d4
commit 42b360f479
2 changed files with 20 additions and 5 deletions

View file

@ -1249,7 +1249,7 @@ class App
} }
$router = new App\Router(); $router = new App\Router();
$this->collectRoutes($router->routeCollector); $this->collectRoutes($router->getRouteCollector());
$this->module_class = $router->getModuleClass($this->cmd); $this->module_class = $router->getModuleClass($this->cmd);
@ -1507,7 +1507,7 @@ class App
} }
/** /**
* @brief Static declaration of Friendica routes. * Static declaration of Friendica routes.
* *
* Supports: * Supports:
* - Route groups * - Route groups
@ -1518,6 +1518,7 @@ class App
* *
* Handler must be the name of a class extending Friendica\BaseModule. * Handler must be the name of a class extending Friendica\BaseModule.
* *
* @brief Static declaration of Friendica routes.
* @param RouteCollector $routeCollector * @param RouteCollector $routeCollector
* @throws InternalServerErrorException * @throws InternalServerErrorException
*/ */

View file

@ -7,12 +7,21 @@ use FastRoute\DataGenerator\GroupCountBased;
use FastRoute\Dispatcher; use FastRoute\Dispatcher;
use FastRoute\RouteCollector; use FastRoute\RouteCollector;
use FastRoute\RouteParser\Std; use FastRoute\RouteParser\Std;
use Friendica\Module\Itemsource;
/**
* Wrapper for FastRoute\Router
*
* This wrapper only makes use of a subset of the router features, mainly parses a route rule to return the relevant
* module class.
*
* Actual routes are defined in App->collectRoutes.
*
* @package Friendica\App
*/
class Router class Router
{ {
/** @var RouteCollector */ /** @var RouteCollector */
public $routeCollector; protected $routeCollector;
public function __construct(RouteCollector $routeCollector = null) public function __construct(RouteCollector $routeCollector = null)
{ {
@ -23,6 +32,11 @@ class Router
$this->routeCollector = $routeCollector; $this->routeCollector = $routeCollector;
} }
public function getRouteCollector()
{
return $this->routeCollector;
}
public function getModuleClass($cmd) public function getModuleClass($cmd)
{ {
$cmd = '/' . ltrim($cmd, '/'); $cmd = '/' . ltrim($cmd, '/');
@ -40,4 +54,4 @@ class Router
return $moduleClass; return $moduleClass;
} }
} }