PHPackages richardgoldstein/fat-free-routes - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. richardgoldstein/fat-free-routes ActiveLibrary[Utility & Helpers](/categories/utility) richardgoldstein/fat-free-routes ================================ Generate FatFreeFramework Routes from DocBlocks 0.1.3(8y ago)81372MITPHPPHP >=7.0CI failing Since Jan 12Pushed 4y ago1 watchersCompare [ Source](https://github.com/richgoldmd/fat-free-routes)[ Packagist](https://packagist.org/packages/richardgoldstein/fat-free-routes)[ RSS](/packages/richardgoldstein-fat-free-routes/feed)WikiDiscussions master Synced yesterday READMEChangelogDependencies (6)Versions (9)Used By (0) FatFreeRoutes ============= [](#fatfreeroutes) #### Note: [](#note) This tool has been completely refactored into a plugable architecture to allow for future expansion. Note the following: 1. The command line parameter names have changed 2. The @routeJS tag is no longer supported, and has been replaced by the `[js]` modifier. 3. The documentation is a work-in-progress. --- PHP >= 7.0 (To use the tool), PHP >= 5.4 (For generated code) This development tool allows one to specify routes in the [Fat Free Framework](http://fatfreeframework.com) in DocBlock format in the controller class. Furthermore, it is build with a pluggable interface to allow for future expansion beyond route generation. Example ------- [](#example) ``` class MyFatFreeController { /** * @route GET @alias: /path/here * * @param \Base $f3 * @param array $args */ public function someHandler(\Base $f3, $args) { //... } } ``` Adding the `@route` tag above is equivalent to calling ``` $f3->route('GET @alias: /path/here', 'MyFatFreeController->someHandler'); ``` or specifying the route in a config file. The tool, `f3routes` produces a php file suitable to be `required` in `index.php` and provides a method to install the routes. ``` function installRoutes($includeDev = true) { // ... } ``` Require the generated file in `index.php` and call `installRoutes($includeDev);`before calling `$f3->run();` There is also the option to generate a JavaScript file so that routes can be easily built in Javascript for front-end use. Tags ---- [](#tags) The following DocBlock tags can be used `@route`Applies to a class method, and follows the same syntax as Fat Free Framework routes, using the syntax ``` @route @alias: path [ajax|cli|sync] ``` Replaceable tokens can be used in the path. The alias is optional, as are the route modifiers in brackets `[ ]`. `f3routes` supports additional values in the route modifier portion surrounded by brackets `[ ]`. This can be a comma-separated list of the existing F3 modifiers (ajax, cli, or sync), and the following additional modifiers: - `ttl=` Set the `$ttl` parameter to `Base->route()` - `kbps=` Set the `$kbps` parameter to `Base->route()` - `js` Expose the alias in the Javascript code. The order of the items in the modifier section in unimportant, except that only the last one of `ajax`, `sync`, or `cli` are preserved. Here are some examples of `@route` tags using modifiers: ``` @route GET|POST @alias: /some/path/@id [sync] @route GET @alias2: /some/other/path [ajax,js,ttl=3600] ``` `@devroute` Same as `@route` but only installed if installRoutes() is called with `true`. `@routeBase` Specified in the DocBlock for the class, this prepends a path fragment to all of the route paths specified in the methods by `@route` or `@devroute`. `@routeMap` and `@devrouteMap` The equivalent of the F3 map function, these create routes for RESTful controllers. These also allow specification of an alias for exposure in the Javascript output, which is enabled by adding `[js]` at the end of the tag: ``` /** * * @routeMap @mapAlias: /company/@id [js] * */ class Company { // ... } ``` This is equivalent to ``` $f3->map('/company/@id', 'Company'); ``` If a @routeBase is set, the map path will also be prepended. Note that f3routes supports the proposed PSR-5 PHPDoc standard: all tags can be prefixed or namespaced with `f3routes`. The following are equivalent: ``` /** * * @route GET /mypath * @f3routes-route GET /mypath * @f3routes\route GET /mypath * @\f3routes\route GET /mypath */ public function myHandler(....) { // ... ``` Command Line Parameters ----------------------- [](#command-line-parameters) - `-f, --force` Force the entire route map to be regenerated. If no cache file is specified, this has no effect, as the route table will be generated from scratch in that case. - `-v, --verbose` Verbose output. - `--cache-file=` If specified, a cache-file will save the resulting route map, so that only files that have changed need to be re-parsed. The same cache file should be used on subsequent calls for the same project. - `--source-dir=` *This is required.* Specifies the directory that contains PHP files. This parameter can be specified more than once. Directories are scanned recursively. - `--output-php=` *This is required.* Specifies the file to be written with the generated PHP code. - `--output-js=` This is an optional parameter. If specified, a fle containing JS code and a route map will be produced. Only routes explicitly flagged for JS output will be emitted, One use case is to incorporate f3routes into a file watcher, and update the routes in real-time as the controller classes are modified. Example ------- [](#example-1) ``` f3routes --source-dir=/myprojects/src/controllers \ --output-php=/myproject/src/generated/routes.php \ --cache-file=/myproject/src/generated/cache.f3r ``` Installation ------------ [](#installation) `f3routes` can be installed via composer: ``` composer require --dev richardgoldstein/fat-free-routes ``` You may need to specify the minimum stability as this is still in dev. Once installed via composer, `f3routes` can be found in vendor/bin: ``` ./vendor/bin/f3routes --controller-dir=... ``` or ``` composer exec f3routes ... ``` I include it in a gulp task: ``` var run=require('gulp-run'); // ... gulp.task('php-routes', ['clean-dist-app'], function(cb) { var cmd = new run.Command([ './vendor/bin/f3routes', '--cache-file=./conf/route-cache.f3r', '--source-dir=./src/controllers', '--output-php=./conf/routes.php', '--output-js=./assets/js/generated/routes.js' ].join(' ')); cmd.exec('', cb); }); ``` TODO ---- [](#todo) 1. Elaborate on the JavaScript output 2. [Plug-In documentation](PLUGINS.md) 3. Needs new unit tests since refactoring. 4. More examples 5. How to use the rendered PHP and JavaScript ### Health Score 27 — LowBetter than 49% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity17 Limited adoption so far Community9 Small or concentrated contributor base Maturity53 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~17 days Total 5 Last Release 2973d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/21605243f010f5cc64e5fd2c888f5052eb2b5a4e1dc8540fdc29893766260319?d=identicon)[richgoldmd](/maintainers/richgoldmd) --- Top Contributors [![richgoldmd](https://avatars.githubusercontent.com/u/9498676?v=4)](https://github.com/richgoldmd "richgoldmd (8 commits)") --- Tags fat-free frameworkF3fatfree ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/richardgoldstein-fat-free-routes/health.svg) ``` [![Health](https://phpackages.com/badges/richardgoldstein-fat-free-routes/health.svg)](https://phpackages.com/packages/richardgoldstein-fat-free-routes) ``` ### Alternatives [phpdocumentor/reflection-docblock With this component, a library can provide support for annotations via DocBlocks or otherwise retrieve information that is embedded in a DocBlock. 9.4k722.2M1.2k](/packages/phpdocumentor-reflection-docblock)[spatie/laravel-data Create unified resources and data transfer objects 1.7k28.9M627](/packages/spatie-laravel-data)[spatie/laravel-settings Store your application settings 1.5k5.9M72](/packages/spatie-laravel-settings)[phpdocumentor/reflection Reflection library to do Static Analysis for PHP Projects 12521.4M109](/packages/phpdocumentor-reflection)[xfra35/f3-cron Job scheduling for the PHP Fat-Free Framework 73107.5k](/packages/xfra35-f3-cron)[cognesy/instructor-php The complete AI toolkit for PHP: unified LLM API, structured outputs, agents, and coding agent control 310107.9k1](/packages/cognesy-instructor-php) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)