change readme and improvement Urlgenerator class

Author: Fad M.R

README.md

@@ -1,37 +1,107 @@
-# PHP-Routing
-A simple Router for PHP using PSR-7 message implementation
+#A simple Router for PHP App using PSR-7 message implementation
+
 
 ## Requirements
 
- * PHP 7.2.0+
- * Enable URL rewriting on your web server
- * Need package for PSR-7 HTTP Message
-   (example : guzzlehttp/psr7 )
- 
- ## Installation
- 
- soon
- 
- ## Usage
+* PHP version 7.3
+* Enable URL rewriting on your web server
+* Need package for PSR-7 HTTP Message
+  (example : guzzlehttp/psr7 )
 
-Simple usage :
+**How to use ?**
 
-``` php
+```php
 <?php
+class IndexController {
+
+    public function __invoke()
+    {
+        return 'Hello world!!';
+    }
+}
+
+class ArticleController {
+
+    public function getAll()
+    {
+        // db get all post
+        return json_encode([
+            ['id' => 1],
+            ['id' => 2],
+            ['id' => 3]
+        ]);
+    }
+
+    public function get(int $id)
+    {
+        // db get post by id
+        return json_encode(['id' => $id]);
+    }
+
+    public function put(int $id)
+    {
+        // db edited post by id
+        return json_encode(['id' => $id]);
+    }
+
+    public function post()
+    {
+        // db create post
+        return json_encode(['id' => 4]);
+    }
+}
 
-use Webby\Routing\Route;
-use Webby\Routing\Router;
+$router = new \DevCoder\Router([
+    new \DevCoder\Route('home_page', '/', [IndexController::class]),
+    new \DevCoder\Route('api_articles_collection', '/api/articles', [ArticleController::class, 'getAll']),
+    new \DevCoder\Route('api_articles', '/api/articles/{id}', [ArticleController::class, 'get']),
+]);
+```
+##Example
+$_SERVER['REQUEST_URI'] = '/api/articles/2'
+$_SERVER['REQUEST_METHOD'] = 'GET'
+```php
+try {
+    // Example
+    // \Psr\Http\Message\ServerRequestInterface
+    //$route = $router->match(ServerRequestFactory::fromGlobals());
+    // OR
+
+    // $_SERVER['REQUEST_URI'] = '/api/articles/2'
+    // $_SERVER['REQUEST_METHOD'] = 'GET'
+    $route = $router->matchFromPath($_SERVER['REQUEST_URI'], $_SERVER['REQUEST_METHOD']);
+
+    $parameters = $route->getParameters();
+    // $arguments = ['id' => 2]
+    $arguments = $route->getVars();
+
+    $controllerName = $parameters[0];
+    $methodName = $parameters[1] ?? null;
 
-$route = new Route('home_page', '/', HomeController::class, 'indexAction');
-$router = (new Router())
-            ->addRoute($route);
-            
- /**
- * @var ServerRequestInterface $request
- */        
-$routeMatching = $router->match($request);
+    $controller = new $controllerName();
+    if (!is_callable($controller)) {
+        $controller =  [$controller, $methodName];
+    }
 
-$controller = $routeMatching->getController();
-$action = $routeMatching->getAction();
+    echo $controller(...array_values($arguments));
 
+} catch (\Exception $exception) {
+    header("HTTP/1.0 404 Not Found");
+}
 ```
+How to Define Route methods
+```php
+new \DevCoder\Route('api_articles_post', '/api/articles', [ArticleController::class, 'post'], ['POST']);
+new \DevCoder\Route('api_articles_put', '/api/articles/{id}', [ArticleController::class, 'put'], ['PUT']);
+```
+Generating URLs
+```php
+echo $router->generateUri('home_page');
+// /
+echo $router->generateUri('api_articles', ['id' => 1]);
+// /api/articles/1
+```
+
+Ideal for small project
+Simple and easy!
+[https://github.com/devcoder-xyz/php-router](https://github.com/devcoder-xyz/php-router)

src/Router.php

@@ -29,7 +29,7 @@ public function __construct(array $routes = [])
     {
         $this->routes = new \ArrayIterator();
         $this->urlGenerator = new UrlGenerator($this->routes);
-        foreach (array_unique($routes) as $route) {
+        foreach ($routes as $route) {
             $this->add($route);
         }
     }

src/UrlGenerator.php

@@ -7,18 +7,18 @@
 final class UrlGenerator
 {
     /**
-     * @var \ArrayIterator<Route>
+     * @var \ArrayAccess<Route>
      */
     private $routes;
 
-    public function __construct(\ArrayIterator $routes)
+    public function __construct(\ArrayAccess $routes)
     {
         $this->routes = $routes;
     }
 
     public function generate(string $name, array $parameters = []): string
     {
-        if (array_key_exists($name, $this->routes) === false) {
+        if ($this->routes->offsetExists($name) === false) {
             throw new \InvalidArgumentException(
                 sprintf('Unknown %s name route', $name)
             );