mirror of https://github.com/friendica/friendica
Philipp
4 years ago
committed by
GitHub
commit
f69d73b5ff
@ -0,0 +1,83 @@
|
||||
<?php
|
||||
|
||||
namespace Friendica\App;
|
||||
|
||||
|
||||
use FastRoute\DataGenerator\GroupCountBased;
|
||||
use FastRoute\Dispatcher;
|
||||
use FastRoute\RouteCollector;
|
||||
use FastRoute\RouteParser\Std;
|
||||
use Friendica\Module;
|
||||
|
||||
/**
|
||||
* 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
|
||||
{
|
||||
/** @var RouteCollector */
|
||||
protected $routeCollector;
|
||||
|
||||
/**
|
||||
* Static declaration of Friendica routes.
|
||||
*
|
||||
* Supports:
|
||||
* - Route groups
|
||||
* - Variable parts
|
||||
* Disregards:
|
||||
* - HTTP method other than GET
|
||||
* - Named parameters
|
||||
*
|
||||
* Handler must be the name of a class extending Friendica\BaseModule.
|
||||
*
|
||||
* @brief Static declaration of Friendica routes.
|
||||
*/
|
||||
public function collectRoutes()
|
||||
{
|
||||
$this->routeCollector->addRoute(['GET', 'POST'], '/itemsource[/{guid}]', Module\Itemsource::class);
|
||||
}
|
||||
|
||||
public function __construct(RouteCollector $routeCollector = null)
|
||||
{
|
||||
if (!$routeCollector) {
|
||||
$routeCollector = new RouteCollector(new Std(), new GroupCountBased());
|
||||
}
|
||||
|
||||
$this->routeCollector = $routeCollector;
|
||||
}
|
||||
|
||||
public function getRouteCollector()
|
||||
{
|
||||
return $this->routeCollector;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the relevant module class name for the given page URI or NULL if no route rule matched.
|
||||
*
|
||||
* @param string $cmd The path component of the request URL without the query string
|
||||
* @return string|null A Friendica\BaseModule-extending class name if a route rule matched
|
||||
*/
|
||||
public function getModuleClass($cmd)
|
||||
{
|
||||
$cmd = '/' . ltrim($cmd, '/');
|
||||
|
||||
$dispatcher = new \FastRoute\Dispatcher\GroupCountBased($this->routeCollector->getData());
|
||||
|
||||
$moduleClass = null;
|
||||
|
||||
// @TODO: Enable method-specific modules
|
||||
$httpMethod = 'GET';
|
||||
$routeInfo = $dispatcher->dispatch($httpMethod, $cmd);
|
||||
if ($routeInfo[0] === Dispatcher::FOUND) {
|
||||
$moduleClass = $routeInfo[1];
|
||||
}
|
||||
|
||||
return $moduleClass;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,42 @@
|
||||
<?php
|
||||
|
||||
namespace Friendica\Test\src\App;
|
||||
|
||||
use Friendica\App\Router;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
class RouterTest extends TestCase
|
||||
{
|
||||
public function testGetModuleClass()
|
||||
{
|
||||
$router = new Router();
|
||||
|
||||
$routeCollector = $router->getRouteCollector();
|
||||
$routeCollector->addRoute(['GET'], '/', 'IndexModuleClassName');
|
||||
$routeCollector->addRoute(['GET'], '/test', 'TestModuleClassName');
|
||||
$routeCollector->addRoute(['GET'], '/test/sub', 'TestSubModuleClassName');
|
||||
$routeCollector->addRoute(['GET'], '/optional[/option]', 'OptionalModuleClassName');
|
||||
$routeCollector->addRoute(['GET'], '/variable/{var}', 'VariableModuleClassName');
|
||||
$routeCollector->addRoute(['GET'], '/optionalvariable[/{option}]', 'OptionalVariableModuleClassName');
|
||||
$routeCollector->addRoute(['POST', 'PUT', 'PATCH', 'DELETE', 'HEAD'], '/unsupported', 'UnsupportedMethodModuleClassName');
|
||||
|
||||
$this->assertEquals('IndexModuleClassName', $router->getModuleClass('/'));
|
||||
|
||||
$this->assertEquals('TestModuleClassName', $router->getModuleClass('/test'));
|
||||
$this->assertNull($router->getModuleClass('/tes'));
|
||||
|
||||
$this->assertEquals('TestSubModuleClassName', $router->getModuleClass('/test/sub'));
|
||||
|
||||
$this->assertEquals('OptionalModuleClassName', $router->getModuleClass('/optional'));
|
||||
$this->assertEquals('OptionalModuleClassName', $router->getModuleClass('/optional/option'));
|
||||
$this->assertNull($router->getModuleClass('/optional/opt'));
|
||||
|
||||
$this->assertEquals('VariableModuleClassName', $router->getModuleClass('/variable/123abc'));
|
||||
$this->assertNull($router->getModuleClass('/variable'));
|
||||
|
||||
$this->assertEquals('OptionalVariableModuleClassName', $router->getModuleClass('/optionalvariable'));
|
||||
$this->assertEquals('OptionalVariableModuleClassName', $router->getModuleClass('/optionalvariable/123abc'));
|
||||
|
||||
$this->assertNull($router->getModuleClass('/unsupported'));
|
||||
}
|
||||
}
|
||||
Loading…
Reference in new issue