Repository navigation
Expand file tree
/
Copy pathforge-router.html
More file actions
1001 lines (970 loc) · 58.1 KB
/
Copy pathforge-router.html
File metadata and controls
1001 lines (970 loc) · 58.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!doctype html>
<html lang="en" class="scroll-smooth">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Forge Kernel - ForgeRouter</title>
<script src="https://cdn.tailwindcss.com"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/components/prism-core.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/plugins/autoloader/prism-autoloader.min.js"></script>
<link
href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/themes/prism-tomorrow.min.css"
rel="stylesheet"
/>
<link
href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css"
rel="stylesheet"
/>
<link rel="stylesheet" href="assets/css/docs.css" />
</head>
<body class="bg-gray-50 text-gray-900">
<!-- Navigation -->
<nav class="bg-white shadow-sm border-b">
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8">
<div class="flex justify-between h-16">
<div class="flex items-center">
<div class="flex-shrink-0">
<h1 class="text-xl font-bold text-gray-900">
Forge Kernel
</h1>
</div>
<div class="hidden sm:ml-6 sm:flex sm:space-x-8">
<a
href="index.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
Home
</a>
<a
href="getting-started.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
Getting Started
</a>
<a
href="core-concepts.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
Core Concepts
</a>
<a
href="capabilities.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
Capabilities
</a>
<a
href="api-reference.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
API Reference
</a>
<a
href="tutorial.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
Tutorials
</a>
</div>
</div>
<div class="flex items-center sm:hidden">
<button
id="mobile-menu-button"
class="text-gray-700 hover:text-blue-600 p-2"
>
<i class="fas fa-bars text-xl"></i>
</button>
</div>
</div>
</div>
<div
id="mobile-menu"
class="sm:hidden hidden bg-white border-t border-gray-200"
>
<div class="px-2 pt-2 pb-3 space-y-1">
<a
href="index.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>Home</a
>
<a
href="getting-started.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>Getting Started</a
>
<a
href="core-concepts.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>Core Concepts</a
>
<a
href="capabilities.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>Capabilities</a
>
<a
href="api-reference.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>API Reference</a
>
<a
href="tutorial.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>Tutorials</a
>
</div>
</div>
</nav>
<!-- Main Content -->
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8 py-8">
<div class="flex flex-col lg:flex-row gap-8">
<!-- Sidebar Navigation -->
<div id="sidebar-nav" class="lg:w-1/4">
<div class="bg-white rounded-lg shadow-sm p-6 sticky top-8">
<h3 class="text-lg font-semibold text-gray-900 mb-4">
ForgeRouter
</h3>
<nav class="space-y-2">
<a
href="#overview"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Overview</a
>
<a
href="#routes-controllers"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Routes & Controllers</a
>
<a
href="#requests"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Requests</a
>
<a
href="#responses"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Responses</a
>
<a
href="#middleware"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Middleware</a
>
<a
href="#sessions-csrf"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Sessions & CSRF</a
>
<a
href="#security"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Security & Hardening</a
>
<a
href="#hooks-extensions"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Hooks & Extension Points</a
>
<a
href="#errors-maintenance"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Errors & Maintenance</a
>
<a
href="#command-line"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>The Command Line</a
>
<a
href="#configuration"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Configuration</a
>
<a
href="#installation"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Installation</a
>
</nav>
<div class="mt-6 pt-6 border-t border-gray-200">
<h4 class="font-semibold text-sm mb-3 text-blue-600">
Related
</h4>
<nav class="space-y-2">
<a
href="forge-view.html"
class="block text-gray-600 hover:text-blue-600 py-1 text-sm"
>ForgeView — render responses as pages →</a
>
<a
href="forge-wire.html"
class="block text-gray-600 hover:text-blue-600 py-1 text-sm"
>ForgeWire — reactive pages over HTTP →</a
>
<a
href="capabilities.html"
class="block text-gray-600 hover:text-blue-600 py-1 text-sm"
>All capabilities →</a
>
</nav>
</div>
</div>
</div>
<!-- Main Content -->
<div class="lg:w-3/4">
<div class="bg-white rounded-lg shadow-sm p-8">
<h1 class="text-4xl font-bold text-gray-900 mb-6">
ForgeRouter
</h1>
<p class="text-xl text-gray-600 mb-4">
A component that turns <strong>your app</strong> into a
web app: attribute-based routing, HTTP requests and
responses, middleware, sessions, and security.
</p>
<!-- Overview -->
<section id="overview" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Overview
</h2>
<p class="text-gray-600 mb-4">
ForgeRouter is what makes the Kernel speak HTTP. It's
the component that receives a request, matches it to one
of <em>your app's</em> controller methods, runs the
middleware you've chosen, and sends back a response. If
you started from an HTTP blueprint or a web starter,
it's already wired in; otherwise you add it like any
capability.
</p>
<div
class="bg-blue-50 border border-blue-200 rounded-lg p-6 mb-6"
>
<h3 class="font-semibold text-lg mb-4">
What it gives you
</h3>
<div class="grid md:grid-cols-2 gap-4 text-sm text-gray-700">
<ul class="space-y-2 list-disc list-inside">
<li>Attribute-based routes on your controllers</li>
<li>URL parameters with constraints and casting</li>
<li>A full HTTP Request and Response model</li>
<li>Global, web, and API middleware groups</li>
</ul>
<ul class="space-y-2 list-disc list-inside">
<li>Sessions and CSRF protection built in</li>
<li>CORS, CSP, rate limiting, circuit breaker</li>
<li>Route + hook caching for speed</li>
<li>A dev server (<code>serve</code>) and generators</li>
</ul>
</div>
</div>
<p class="text-gray-600">
You decide which routes exist, what middleware guards
them, and how each request is answered — the component
supplies the transport, matching, and plumbing.
</p>
</section>
<!-- Routes & Controllers -->
<section
id="routes-controllers"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Routes & Controllers
</h2>
<p class="text-gray-600 mb-4">
Routes are declared as PHP attributes on controller
methods. The router discovers your controllers
automatically — from your app's controller directory and
from every module's — so there are no route registries
to maintain.
</p>
<div
class="code-block p-6 text-white rounded-lg mb-4"
>
<pre><code class="language-php">use Modules\ForgeRouter\Routing\Endpoint;
use Modules\ForgeRouter\Routing\Routable;
use Modules\ForgeRouter\Http\Response;
#[Routable(prefix: '/blog')]
final class BlogController
{
#[Endpoint('/posts/{id}', 'GET')]
public function show(int $id, Request $request): Response
{
return $this->view('blog/show', ['id' => $id]);
}
}</code></pre>
</div>
<p class="text-gray-600 mb-4">
Key attribute options:
</p>
<div class="overflow-x-auto mb-6">
<table class="min-w-full text-sm text-gray-700">
<thead>
<tr class="border-b border-gray-300 text-left">
<th class="py-2 pr-4">Attribute</th>
<th class="py-2 pr-4">Where</th>
<th class="py-2">What it does</th>
</tr>
</thead>
<tbody>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">#[Endpoint]</td>
<td class="py-2 pr-4">method</td>
<td class="py-2">Declares a route. Repeatable. Takes path, method, middleware, permissions, override.</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">#[Routable(prefix)]</td>
<td class="py-2 pr-4">class</td>
<td class="py-2">Prefixes every endpoint path in that controller.</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">#[ApiRoute]</td>
<td class="py-2 pr-4">method</td>
<td class="py-2">Shortcut that places the route under /api/v1.</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">#[UseMiddleware]</td>
<td class="py-2 pr-4">class/method</td>
<td class="py-2">Adds middleware (repeatable) to the route.</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">#[Layout]</td>
<td class="py-2 pr-4">class/method</td>
<td class="py-2">Chooses the view layout for the response (combined with ForgeView).</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">#[RequiresRole]</td>
<td class="py-2 pr-4">class/method</td>
<td class="py-2">Attaches a required role to the route.</td>
</tr>
</tbody>
</table>
</div>
<p class="text-gray-600 mb-4">
<strong>Route parameters</strong> use braces with
optional constraints. The router matches the constraining
pattern and casts the value to the controller parameter's
declared PHP type (<code>int</code>, <code>float</code>, or
<code>bool</code>). A parameter named <code>request</code>
receives the current Request object.
</p>
<div class="overflow-x-auto mb-4">
<table class="min-w-full text-sm text-gray-700">
<thead>
<tr class="border-b border-gray-300 text-left">
<th class="py-2 pr-4">Pattern</th>
<th class="py-2 pr-4">Matches</th>
</tr>
</thead>
<tbody>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">/posts/{id}</td>
<td class="py-2 pr-4">letters, digits, underscore, dash</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">/posts/{id:\d+}</td>
<td class="py-2 pr-4">the custom regex <code>\d+</code></td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">/files/{path:.+}</td>
<td class="py-2 pr-4">any path, greedy (can include slashes)</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">/x/{slug:no-slash}</td>
<td class="py-2 pr-4">a single segment with no slash</td>
</tr>
</tbody>
</table>
</div>
<p class="text-gray-600">
For API-first controllers, <code>#[ApiRoute]</code> nests
routes under <code>/api/v1</code> automatically, brings
the <code>api</code> middleware, and pairs with the
<code>ApiResponse</code> helpers for JSON.
</p>
</section>
<!-- Requests -->
<section id="requests" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Requests
</h2>
<p class="text-gray-600 mb-4">
The router builds a <code>Request</code> object from the
incoming request. It's available as the container's
<code>Request</code> instance, via the
<code>request()</code> helper, or as a
<code>request</code> parameter on any controller method.
</p>
<div
class="code-block p-6 text-white rounded-lg mb-4"
>
<pre><code class="language-php">$title = $request->input('title'); // POST first, then query
$page = $request->query('page', 1); // query string only
$dump = $request->all(); // GET + POST merged
$token = $request->json('token'); // JSON body (cached)
$auth = $request->getHeader('Authorization');
$clientIp = $request->getClientIp(); // proxy-aware, spoof-safe
$file = $request->file('avatar'); // UploadedFile or null
$isTls = $request->isSecure(); // https-aware</code></pre>
</div>
<p class="text-gray-600 mb-4">
Method spoofing is built in: a <code>_method</code> field
or JSON body lets forms issue PUT, PATCH, and DELETE.
Cookies surface as <code>Cookie</code> objects via
<code>cookies()</code> and <code>cookie()</code>.
Middleware can tag the request with
<code>setAttribute()</code>/<code>getAttribute()</code>,
which is how the router exposes the matched route
(<code>_route</code>) and required permissions/roles.
</p>
<p class="text-gray-600">
Uploaded files become <code>UploadedFile</code> objects
with safe <code>moveTo()</code> (verify-then-rename),
<code>getClientFilename()</code>, and stream access —
no direct <code>$_FILES</code> juggling in your app.
</p>
</section>
<!-- Responses -->
<section id="responses" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Responses
</h2>
<p class="text-gray-600 mb-4">
Controllers build and return a <code>Response</code>.
Anything a controller returns is wrapped in one, but
you'll usually construct them directly for full control
over status, headers, and cookies.
</p>
<div
class="code-block p-6 text-white rounded-lg mb-4"
>
<pre><code class="language-php">use Modules\ForgeRouter\Http\Response;
use Modules\ForgeRouter\Http\Cookie;
$response = (new Response('<h1>Hello</h1>', 200))
->setHeader('Content-Type', 'text/html')
->setCookie(new Cookie('theme', 'dark', 86400));</code></pre>
</div>
<p class="text-gray-600 mb-4">
There are several ready-made helpers:
</p>
<div class="overflow-x-auto mb-4">
<table class="min-w-full text-sm text-gray-700">
<thead>
<tr class="border-b border-gray-300 text-left">
<th class="py-2 pr-4">Helper</th>
<th class="py-2 pr-4">Purpose</th>
</tr>
</thead>
<tbody>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">Redirect::to($uri, $status)</td>
<td class="py-2 pr-4">Redirect response (302 by default)</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">Redirect::back($request)</td>
<td class="py-2 pr-4">Redirect to the referer</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">new ApiResponse($data, $status)</td>
<td class="py-2 pr-4">JSON envelope with <code>data</code> and optional <code>meta</code></td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">ResponseHelper::jsonResponse()</td>
<td class="py-2 pr-4">JSON with Content-Type header</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">ResponseHelper::csvResponse()</td>
<td class="py-2 pr-4">CSV download attachment</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">ResponseHelper::downloadResponse()</td>
<td class="py-2 pr-4">Download a string as a file</td>
</tr>
</tbody>
</table>
</div>
<p class="text-gray-600">
The <code>ResponseHelper</code> trait also includes JSON-aware
<code>createResponse()</code> and <code>createErrorResponse()</code>
that hand API clients JSON and others HTML.
</p>
</section>
<!-- Middleware -->
<section id="middleware" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Middleware
</h2>
<p class="text-gray-600 mb-4">
Middleware wraps the request/response lifecycle. A
middleware receives the request and calls <code>next()</code>
to continue; it can short-circuit with a response. You
compose them in groups, and the router runs the
<code>global</code> group plus the route's own middleware.
</p>
<div
class="code-block p-6 text-white rounded-lg mb-4"
>
<pre><code class="language-php">use Modules\ForgeRouter\Http\Middleware;
use Modules\ForgeRouter\Http\Request;
use Modules\ForgeRouter\Http\Response;
final class MaintenanceMiddleware extends Middleware
{
public function handle(Request $request, callable $next): Response
{
if (app_is_down()) {
return new Response('Be back soon.', 503);
}
return $next($request);
}
}</code></pre>
</div>
<p class="text-gray-600 mb-4">
Middleware is assigned two ways: group definitions in
<code>config/middleware.php</code> and per-route
<code>#[UseMiddleware]</code>. Groups can also be
registered by modules at boot. The engine itself wires up
essential middleware automatically:
</p>
<div class="overflow-x-auto mb-4">
<table class="min-w-full text-sm text-gray-700">
<thead>
<tr class="border-b border-gray-300 text-left">
<th class="py-2 pr-4">Middleware (built in)</th>
<th class="py-2 pr-4">Group</th>
<th class="py-2">What it does</th>
</tr>
</thead>
<tbody>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">Observability</td>
<td class="py-2 pr-4">global</td>
<td class="py-2">Tracks request spans and status for observability.</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">RateLimit</td>
<td class="py-2 pr-4">global</td>
<td class="py-2">Per-IP sliding-window rate limiting; 429 with headers.</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">CircuitBreaker</td>
<td class="py-2 pr-4">global</td>
<td class="py-2">Trips after repeated 5xx; serves 503 to protect the app.</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">SanitizeInput</td>
<td class="py-2 pr-4">global</td>
<td class="py-2">Escapes GET/POST/REQUEST input before your controller sees it.</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">Session</td>
<td class="py-2 pr-4">web</td>
<td class="py-2">Starts and saves the session.</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">Csrf</td>
<td class="py-2 pr-4">web</td>
<td class="py-2">Validates CSRF tokens on state-changing requests; 419 on failure.</td>
</tr>
</tbody>
</table>
</div>
<p class="text-gray-600 mb-4">
More built-ins you can turn on per group or route: CORS,
Compression, HttpCache (ETag/Last-Modified), IpWhiteList,
RelaxSecurityHeaders (CSP), Cookie, <code>api</code>
(ApiMiddleware), and ApiKey.
</p>
<p class="text-gray-600">
The <code>generate:middleware</code> command scaffolds a
new middleware class for your app or a module. Use
<code>#[UseMiddleware('name')]</code> to attach it to a
route or controller.
</p>
</section>
<!-- Sessions & CSRF -->
<section id="sessions-csrf" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Sessions & CSRF
</h2>
<p class="text-gray-600 mb-4">
The <code>web</code> middleware group starts a session and
protects your forms against cross-site request forgery.
Helpers make this painless in templates:
</p>
<div
class="code-block p-6 text-white rounded-lg mb-4"
>
<pre><code class="language-php">// In a view or layout
<?= csrf_input() ?> // hidden _token field
<?= csrf_meta() ?> // meta tag for JS clients
<?= window_csrf_token() ?> // window.csrfToken for modern JS</code></pre>
</div>
<p class="text-gray-600 mb-6">
The middleware validates the token on every
POST/PUT/PATCH/DELETE (via <code>_token</code> or the
<code>X-CSRF-TOKEN</code> header) and returns a 419 on a
mismatch. Tokens are signed by <code>TokenManager</code>
using your app key and expire after a day.
</p>
<div
class="code-block p-6 text-white rounded-lg mb-4"
>
<pre><code class="language-php">// Session access via the Session class
$session->set('user_id', 42);
$id = $session->get('user_id');
$session->setFlash('success', 'Saved!');
$session->regenerate();</code></pre>
</div>
<p class="text-gray-600">
Flash messages are available to your next request and
auto-clear after it's read — handy for echoing
"saved" feedback after a redirect.
</p>
</section>
<!-- Security -->
<section id="security" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Security & Hardening
</h2>
<p class="text-gray-600 mb-4">
ForgeRouter bundles a set of hardening features you turn
on with configuration. They're opt-in so you only enable
what your app needs.
</p>
<div class="overflow-x-auto mb-4">
<table class="min-w-full text-sm text-gray-700">
<thead>
<tr class="border-b border-gray-300 text-left">
<th class="py-2 pr-4">Feature</th>
<th class="py-2 pr-4">Config key</th>
<th class="py-2">Behavior</th>
</tr>
</thead>
<tbody>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4">CORS</td>
<td class="py-2 pr-4 font-mono">forge_router.cors</td>
<td class="py-2">Whitelist origins/methods/headers; 403 on mismatch, echo CORS headers on match.</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4">CSP</td>
<td class="py-2 pr-4 font-mono">forge_router.csp</td>
<td class="py-2">Build a Content-Security-Policy header, merged with external asset sources.</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4">IP whitelist</td>
<td class="py-2 pr-4 font-mono">forge_router.ip_whitelist</td>
<td class="py-2">Reject clients not in the list with 403; no-op when empty.</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4">Input sanitizing</td>
<td class="py-2 pr-4">engine (global)</td>
<td class="py-2">Recursively escapes all incoming GET/POST/REQUEST.</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4">Rate limiting</td>
<td class="py-2 pr-4 font-mono">forge_router.rate_limit</td>
<td class="py-2">DB-backed per-IP window limits, 429 + Retry-After headers.</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4">Circuit breaker</td>
<td class="py-2 pr-4 font-mono">forge_router.circuit_breaker</td>
<td class="py-2">Stops hammering a failing app; serves 503 after repeated 5xx.</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4">API keys</td>
<td class="py-2 pr-4 font-mono">ApiKeyMiddleware</td>
<td class="py-2">Validate X-API-KEY against the api_keys table and required permissions.</td>
</tr>
</tbody>
</table>
</div>
<p class="text-gray-600">
Client IP detection prefers <code>REMOTE_ADDR</code> and
only falls back to forwarded headers when it's absent, so a
spoofed <code>X-Forwarded-For</code> can't bypass rate
limiting or whitelists.
</p>
</section>
<!-- Hooks -->
<section
id="hooks-extensions"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Hooks & Extension Points
</h2>
<p class="text-gray-600 mb-4">
Beyond middleware, you can hook into the request lifecycle
from module code with an attribute on a public method:
</p>
<div
class="code-block p-6 text-white rounded-lg mb-4"
>
<pre><code class="language-php">use Modules\ForgeRouter\Events\RouterHookAttribute;
use Modules\ForgeRouter\Events\RouterHookName;
#[RouterHookAttribute(RouterHookName::BEFORE_REQUEST)]
public function onBefore(Request $request): void
{
// inspect or alter the request before routing
}</code></pre>
</div>
<p class="text-gray-600 mb-6">
The three hooks — <code>BEFORE_REQUEST</code>,
<code>AFTER_REQUEST</code>, and <code>AFTER_RESPONSE</code>
— fire around the kernel, and their compiled callbacks are
cached for speed.
</p>
<p class="text-gray-600 mb-4">
The router also recognizes a set of contracts that let
capabilities plug in cleanly:
</p>
<div class="overflow-x-auto mb-4">
<table class="min-w-full text-sm text-gray-700">
<thead>
<tr class="border-b border-gray-300 text-left">
<th class="py-2 pr-4">Contract</th>
<th class="py-2 pr-4">Extends</th>
</tr>
</thead>
<tbody>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">RequestPreprocessorInterface</td>
<td class="py-2 pr-4">Modify a request before routing.</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">ResponseTransformerInterface</td>
<td class="py-2 pr-4">Modify a response before it's sent.</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">RouteModifierInterface</td>
<td class="py-2 pr-4">Mutate route data at registration.</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">RouteScopeFilterInterface</td>
<td class="py-2 pr-4">Filter which routes register per scope (e.g. tenant vs central).</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">ErrorHandlerInterface</td>
<td class="py-2 pr-4">Final handler for an uncaught exception.</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">ExceptionHandlerInterface</td>
<td class="py-2 pr-4">Chainable interceptor; return a Response or pass through.</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">RequestCollectorInterface</td>
<td class="py-2 pr-4">Collect request/response data (used by debug tools).</td>
</tr>
</tbody>
</table>
</div>
</section>
<!-- Errors & Maintenance -->
<section
id="errors-maintenance"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Errors & Maintenance
</h2>
<p class="text-gray-600 mb-4">
Unmatched URLs return a rendered 404 page, and uncaught
exceptions flow to your error handling (via the
<code>ErrorHandlerInterface</code>). The
<code>ErrorPageRenderer</code> looks for a custom
<code>{code}.php</code> template in your app or modules
before falling back to its default page.
</p>
<div
class="code-block p-6 text-white rounded-lg mb-4"
>
<pre><code class="language-bash"># Put your app into maintenance mode (serves 503)
php forge.php down
# Bring it back
php forge.php up</code></pre>
</div>
<p class="text-gray-600">
Maintenance writes a 503 page under
<code>storage/framework/</code>. The circuit breaker
reuses the same renderer to protect a failing app.
</p>
</section>
<!-- Command Line -->
<section id="command-line" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">
The Command Line
</h2>
<p class="text-gray-600 mb-4">
ForgeRouter ships the dev server and a few generator and
maintenance commands. Five are core commands available
directly; two lifecycle commands are scoped to the
module.
</p>
<div class="overflow-x-auto mb-4">
<table class="min-w-full text-sm text-gray-700">
<thead>
<tr class="border-b border-gray-300 text-left">
<th class="py-2 pr-4">Command</th>
<th class="py-2 pr-4">Purpose</th>
</tr>
</thead>
<tbody>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">serve</td>
<td class="py-2 pr-4">Start the PHP dev server. Options: <code>--host</code> (localhost), <code>--port</code> (8000).</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">generate:endpoint</td>
<td class="py-2 pr-4">Scaffold a controller/endpoint (app or module).</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">generate:middleware</td>
<td class="py-2 pr-4">Scaffold a middleware (app or module).</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">down / up</td>
<td class="py-2 pr-4">Enable / disable maintenance mode.</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">modules:forge-router:init</td>
<td class="py-2 pr-4">Scaffold public entry point and middleware/config files.</td>
</tr>
<tr class="border-b border-gray-100">
<td class="py-2 pr-4 font-mono">modules:forge-router:cleanup</td>
<td class="py-2 pr-4">Remove the scaffolded files (used on uninstall).</td>
</tr>
</tbody>
</table>
</div>
<p class="text-gray-600">
In day-to-day development you'll mostly reach for
<code>serve</code>. It compiles the hook cache, then runs
the built-in PHP server against your <code>public/</code>
directory.
</p>
</section>
<!-- Configuration -->
<section id="configuration" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Configuration
</h2>
<p class="text-gray-600 mb-4">
Everything lives under the <code>forge_router</code> config
key, with sensible defaults. You can override each via
your environment file. The defaults:
</p>
<div
class="code-block p-6 text-white rounded-lg mb-4"
>
<pre><code class="language-bash"># CORS
CORS_ALLOWED_ORIGINS=*
CORS_ALLOWED_METHODS=GET,POST,PUT,DELETE,OPTIONS
CORS_ALLOWED_HEADERS=Content-Type,Authorization
# Rate limiting (enabled, 40 req / 60s; off in dev; localhost bypassed)
RATE_LIMIT_ENABLED=true
RATE_LIMIT_MAX_REQUESTS=40
RATE_LIMIT_TIME_WINDOW=60
# Circuit breaker (5 failures / 300s)
CIRCUIT_BREAKER_MAX_FAILURES=5
CIRCUIT_BREAKER_RESET_TIME=300
# CSP header, off by default
CSP_ENABLED=false
# IP allow-list, empty = allow all
IP_WHITE_LIST=
# Sessions / CSRF
SESSION_ENABLED=true
APP_KEY=your-secure-app-key</code></pre>
</div>
<p class="text-gray-600">
The default middleware groups live in
<code>config/middleware.php</code>: <code>global</code>,
<code>web</code>, and <code>api</code>. Engine middlewares
are merged into these automatically.
</p>
</section>
<!-- Installation -->
<section id="installation" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Installation
</h2>
<p class="text-gray-600 mb-4">
ForgeRouter is a core capability, so a web starter or an
HTTP blueprint typically includes it already. If your
project doesn't have it, add it like any capability:
</p>
<div
class="code-block p-6 text-white rounded-lg mb-6"
>
<pre><code class="language-bash"># Install with the interactive wizard
php forge.php package:install-module
# Or name it directly
php forge.php package:install-module --module=ForgeRouter</code></pre>
</div>
<p class="text-gray-600">
Install runs <code>modules:forge-router:init</code> to
scaffold the public entry point and config; uninstall runs
the cleanup command. It needs no database of its own
unless you enable the DB-backed rate limiter or circuit
breaker (their tables ship as migrations).
</p>
</section>
<div
class="bg-blue-50 border border-blue-200 rounded-lg p-6"
>
<p class="text-gray-700 text-sm">
<strong>Composing your app:</strong> ForgeRouter is the
transport almost everything else runs on. Pair it with
ForgeView to render page responses, ForgeAuth for
authentication middleware, or ForgeWire for reactive pages.
See
<a href="capabilities.html" class="text-blue-600 underline">all capabilities</a>
to keep building.
</p>
</div>
</div>
</div>
</div>
</div>
<script>
document.querySelectorAll('a[href^="#"]').forEach((anchor) => {
anchor.addEventListener("click", function (e) {
e.preventDefault();
const target = document.querySelector(
this.getAttribute("href"),
);
if (target) {
target.scrollIntoView({
behavior: "smooth",
block: "start",
});
}
});
});
const mobileMenuButton =
document.getElementById("mobile-menu-button");
const mobileMenu = document.getElementById("mobile-menu");
if (mobileMenuButton && mobileMenu) {
mobileMenuButton.addEventListener("click", function () {
mobileMenu.classList.toggle("hidden");
});
}
window.addEventListener("scroll", function () {
const sections = document.querySelectorAll(".section-anchor");
const navLinks = document.querySelectorAll(".nav-link");
let current = "";
sections.forEach((section) => {
const sectionTop = section.offsetTop - 100;
if (window.pageYOffset >= sectionTop) {
current = section.getAttribute("id");
}
});
navLinks.forEach((link) => {
link.classList.remove("active");
if (link.getAttribute("href") === "#" + current) {
link.classList.add("active");
}
});
});
</script>
</body>