{"id":17333796,"url":"https://github.com/lotfio/aven","last_synced_at":"2025-06-11T08:08:05.145Z","repository":{"id":54934733,"uuid":"131185728","full_name":"lotfio/aven","owner":"lotfio","description":":tractor: Robust PHP router :tractor:","archived":false,"fork":false,"pushed_at":"2021-01-20T18:35:57.000Z","size":133,"stargazers_count":20,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"develop","last_synced_at":"2025-06-11T08:08:03.121Z","etag":null,"topics":["aven","php-flexible-router","php-router","php-routing","router"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lotfio.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-04-26T16:55:31.000Z","updated_at":"2024-06-19T13:29:46.000Z","dependencies_parsed_at":"2022-08-14T07:00:39.174Z","dependency_job_id":null,"html_url":"https://github.com/lotfio/aven","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lotfio%2Faven","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lotfio%2Faven/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lotfio%2Faven/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lotfio%2Faven/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lotfio","download_url":"https://codeload.github.com/lotfio/aven/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lotfio%2Faven/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259227951,"owners_count":22824903,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aven","php-flexible-router","php-router","php-routing","router"],"created_at":"2024-10-15T15:03:05.015Z","updated_at":"2025-06-11T08:08:05.117Z","avatar_url":"https://github.com/lotfio.png","language":"PHP","funding_links":["https://www.paypal.me/lotfio)*"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\n\u003cimg src=\"https://user-images.githubusercontent.com/18489496/38557718-c7fa6c12-3cc5-11e8-99f9-69e923e24ace.png\" align=\"center\" alt=\"logo\" title=\"logo\"\u003e\n\n\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"#\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/Licence-MIT-f6ca19.svg\" alt=\"LICENSE\" title=\"LICENSE\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"#\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/PHP-7-3498db.svg\" alt=\"PHP 7\" title=\"PHP 7\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"#\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/version-0.4.0-27ae60.svg\" alt=\"version\" title=\"version\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"#\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/coverage-50%25-95a5a6.svg\" alt=\"coverage\" title=\"coverage\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"#\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/downloads-1k-ff5722.svg\" alt=\"downloads\" title=\"downloads\"\u003e\n    \u003c/a\u003e\n \u003ca href=\"#\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/build-passing-e91e63.svg\" alt=\"build\" title=\"build\"\u003e\n    \u003c/a\u003e\n\u003cp align=\"center\"\u003e\n    \u003cstrong\u003e:tractor: Robust PHP router :tractor:\u003c/strong\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n### :fire: Introduction :\n \u003cb\u003eAven\u003c/b\u003e (ayven) is a robust and \u003cb\u003eflexible\u003c/b\u003e PHP router For PHP7 and newer versions.\n\n### :pushpin: Requirements :\n- PHP 7.2 or newer versions\n- PHPUnit \u003e= 8 (for testing purpose)\n\n### :rocket: Installation \u0026 Use :\n```php\n    composer require lotfio/aven\n```\n\n\n### :pencil2: Usage :\n**1- Quick use :**\n\n```php\n \u003c?php\n    require_once 'vendor/autoload.php';\n\n    // here we are using $_SERVER['REQUEST_URI']\n    // you can use $_GET['uri']\n    $router = new Aven\\Router($_SERVER['REQUEST_URI']);\n\n    $router-\u003eget('/', function(){  // with a callback\n        return \"welcome from aven\";\n    });\n\n    $router-\u003eget('/', \"UsersController@method\"); // controller method\n    $router-\u003eget('/', \"UsersController::method\"); // controller static method\n\n\n    $router-\u003einit(); // initialize router\n```\n**2- Available routes :**\n* `GET`, `POST`, `ANY`, `PUT`, `DELETE`, `HEAD`\n```php\n \u003c?php\n\n    $router-\u003eget('/',  function(){ return \" this is get method\"; });\n    $router-\u003epost('/', function(){ return \" this is post method\"; });\n    $router-\u003eany('/',  function(){ return \" this is any method allows all\"; });\n\n    $router-\u003eput('/',    function(){ return \" this is put method. you should send $_POST['_method'] = 'put'\"; });\n    $router-\u003edelete('/', function(){ return \" this is delete method. you should send $_POST['_method'] = 'delete'\"; });\n    $router-\u003ehead('/',   function(){ return \" this is head method. you should send $_POST['_method'] = 'head'\"; });\n```\n\n**3- named routes :**\n```php\n \u003c?php\n    $router-\u003eget('/',  function(){ return \"this is get named route (default)\";})-\u003ename('default');\n```\n\n**4- redirects :**\n* `$router-\u003eredirect(string $routeName, array $params = [], int $httpcode = 301)`\n```php\n \u003c?php\n    // route 1\n    $router-\u003eget('/',  function() use($router){  // accessing this route will redirect you to route2 means /hola\n\n        $router-\u003eredirect('route2'); // if parametrised route you can pass array of parameters\n\n    })-\u003ename('default');\n\n    // route 2\n    $router-\u003eget('/hola',  function(){ return \" welcome to hola from default route\";})-\u003ename('route2');\n```\n\n**5- route parameters :**\n* you can use both parenthesis or curly braces for parameters\n* predefind parameters:\n    - `:int`, `:integer`, `:num`, `:numeric`, `:number` = **\\d+**\n    - `:str`   = **\\w+**\n    - `:alpha` = **[A-z]+**\n```php\n \u003c?php\n\n    $router-\u003eget('/test/(:int)',  function(){}); // evaluates to /test/\\d+\n    $router-\u003eget('/test/(:str)',  function(){}); // evaluates to /test/\\w+\n\n    // optional parameters (if optional parameter uri should end with /)\n    $router-\u003eget('/test/(:id*)',  function(){}); // optional id /test/ or /test/1\n    $router-\u003eget('/test/(:id?)',  function(){}); // zero or one id /test/ or /test/0-9\n\n\n```\n**6- custom route parameters :**\n* `-\u003eregex(array $params)`\n```php\n \u003c?php\n    // override predefined param\n    $router-\u003eget('/test/(:str)',  function(){})-\u003eregex(array(\":str\"=\u003e '[my-reg-ex]'));\n\n    // custom param\n    $router-\u003eget('/test/(:hola)',  function(){})-\u003eregex(array(\":hola\"=\u003e '[my-reg-ex]'));\n\n```\n**7- route groups :**\n* `$router-\u003egroup(string $uri,callable $callback, ?string $groupName)`\n- you can have as many nested groups as you want\n```php\n \u003c?php\n\n   $router-\u003egroup('/mygroup', function($router){  // groups adds prefixes to routes\n\n        $router-\u003eget('/test',  function(){ return \"from /mygroup/test\" }); // evaluates to /mygroup/test\n\n   });\n\n    // multiple groups\n    $router-\u003egroup('/group1', function($router){\n\n        $router-\u003egroup('/group2', function($router){\n\n            $router-\u003eget('/test',  function(){ return \"from /group1/group2/test\" }); // evaluates to /group1/group2/test\n        });\n   });\n\n\n```\n**8- route namespaces :**\n* `$router-\u003enamespace(string $uri,callable $callback)`\n- you can have as many nested namespaces as you want\n```php\n \u003c?php\n\n   $router-\u003enamespace('My\\\\Namespace', function($router){  // you can also use dots (My.Namespace) instead of \\\\\n        $router-\u003eget('/test',  \"TestController@test\"}); // evaluates to My\\\\Namespace\\\\TestController@test\n   });\n\n    // multiple groups\n    $router-\u003enamespace('ns1', function($router){\n\n        $router-\u003enamespace('ns2', function($router){\n\n            $router-\u003eget('/test',  \"TestController@test\"); // evaluates to ns1\\\\ns2\\\\TestController@test\n        });\n   });\n\n\n```\n**9- additionl routes :**\n* `$router-\u003eform(string $uri, $callback|$class, ?array $override, ?string $routeName)`\n```php\n \u003c?php\n    // form route with callback\n    $router-\u003eform('/login', function(){  }); // works both with GET and POST\n\n    // form route with class\n    $router-\u003eform('/login', Login::class); // by default class should have showForm \u0026 submitForm\n\n    // override default form methods\n    $router-\u003eform('/login', Login::class, ['get','post']);\n\n    // named form method\n    $router-\u003eform('/login', Login::class, ['get','post'], 'login.form');\n\n```\n**10- additionl routes :**\n* `$router-\u003ecrud(string $uri, string $class, ?array $only, ?string $routeName)`\n```php\n \u003c?php\n    // crud route\n    // this needs a User class with 4 methods create,read,update,delete\n    // create =\u003e POST user/create\n    // read   =\u003e GET with optional pareter user/read/\n    // update =\u003e PUT with optional pareter user/update/\n    // delete =\u003e DELETE with optional pareter user/delete/\n    $router-\u003ecrud('/user', User::class);\n\n    // disable some methods\n    $router-\u003ecrud('/user', User::class, ['c']); // only create\n    $router-\u003ecrud('/user', User::class, ['create']); // only create\n    $router-\u003ecrud('/user', User::class, ['c', 'u']); //  create \u0026 update\n    $router-\u003ecrud('/user', User::class, ['create', 'update']); //  create \u0026 update\n\n    // named crud\n    $router-\u003ecrud('/user', User::class, NULL, 'myCrud'); //  name can be used for redirections\n\n```\n\n### :computer: Contributing\n\n- Thank you for considering to contribute to ***Package***. All the contribution guidelines are mentioned [here](CONTRIBUTING.md).\n\n### :page_with_curl: ChangeLog\n\n- Here you can find the [ChangeLog](CHANGELOG.md).\n\n### :beer: Support the development\n\n- Share ***Package*** and lets get more stars and more contributors.\n- If this project helped you reduce time to develop, you can give me a cup of coffee :) : **[Paypal](https://www.paypal.me/lotfio)**. 💖\n\n### :clipboard: License\n\n- ***Package*** is an open-source software licensed under the [MIT license](LICENSE).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flotfio%2Faven","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flotfio%2Faven","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flotfio%2Faven/lists"}