Repository navigation
Expand file tree
/
Copy pathtutorial-building-todo-app.html
More file actions
2189 lines (2017 loc) · 97.9 KB
/
Copy pathtutorial-building-todo-app.html
File metadata and controls
2189 lines (2017 loc) · 97.9 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>Building a Todo App - Forge Kernel Documentation</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-blue-600 inline-flex items-center px-1 pt-1 text-sm font-medium border-b-2 border-blue-600"
>
Tutorials
</a>
</div>
</div>
<!-- Mobile menu button -->
<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>
<!-- Mobile menu -->
<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-blue-600 font-medium"
>Tutorials</a
>
</div>
</div>
</nav>
<!-- Main Content -->
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8 py-8">
<!-- Breadcrumb Navigation -->
<nav class="mb-6" aria-label="Breadcrumb">
<ol class="flex items-center space-x-2 text-sm text-gray-500">
<li>
<a href="index.html" class="hover:text-blue-600"
>Home</a
>
</li>
<li><i class="fas fa-chevron-right text-xs"></i></li>
<li>
<a href="tutorial.html" class="hover:text-blue-600"
>Tutorials</a
>
</li>
<li><i class="fas fa-chevron-right text-xs"></i></li>
<li class="text-gray-900 font-medium">
Building a Todo App
</li>
</ol>
</nav>
<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 max-h-[calc(100vh-4rem)] overflow-y-auto"
>
<h3 class="text-lg font-semibold text-gray-900 mb-4">
Tutorial
</h3>
<nav class="space-y-2">
<a
href="#introduction"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Introduction</a
>
<a
href="#project-setup"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Project Setup</a
>
<a
href="#step-1-plain-app"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Step 1: A Plain Todo App</a
>
<a
href="#step-2-accounts"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Step 2: Add User Accounts</a
>
<a
href="#step-3-reactive"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Step 3: Make It Reactive</a
>
<a
href="#step-4-events"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Step 4: Add Events</a
>
<a
href="#step-5-testing"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Step 5: Add Tests</a
>
<a
href="#putting-together"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Putting It All Together</a
>
</nav>
</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">
Building a Todo Application
</h1>
<p class="text-xl text-gray-600 mb-8">
An assembled-app recipe: build a working todo app
incrementally, starting from a tiny Kernel and adding
one capability at a time.
</p>
<!-- Introduction -->
<section id="introduction" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Introduction
</h2>
<p class="text-gray-600 mb-6">
The Forge Kernel is a tiny PHP kernel you use to
<em>build your app</em> — it is not a
framework you have to learn all at once. This
tutorial follows that idea literally. We start
with a plain todo app that works with normal
HTML forms and page reloads. Then, one step at a
time, we add a capability and fork the app a
little further. This is what it means to assemble
an app: take the kernel, plug in a few
capabilities, and your app starts to look like a
framework only once you've assembled it.
</p>
<p class="text-gray-600 mb-6">
At the end, the same todo app will have user
accounts, real-time updates, background events,
and tests — but you'll understand every
piece, because you added it one at a time.
</p>
<h3 class="text-lg font-semibold mb-3">
What You'll Build, Step by Step
</h3>
<ul
class="list-disc list-inside space-y-2 text-gray-600 mb-6"
>
<li>
<strong>Step 1</strong> — a plain todo
app: a migration, a model, a controller, and
a view, saved to a database with normal forms
and redirects.
</li>
<li>
<strong>Step 2</strong> — user
accounts with ForgeAuth, so each user only
sees their own todos.
</li>
<li>
<strong>Step 3</strong> — real-time
updates with ForgeWire, no full page
reloads.
</li>
<li>
<strong>Step 4</strong> — background
events with ForgeEvents.
</li>
<li>
<strong>Step 5</strong> — automated
tests with ForgeTesting.
</li>
</ul>
<h3 class="text-lg font-semibold mb-3">
Capabilities We'll Use
</h3>
<p class="text-gray-600 mb-4">
Each step plugs in a capability. Here's the full
set — you'll install them one per step, so
you only bring in what you actually need:
</p>
<ul
class="list-disc list-inside space-y-2 text-gray-600 mb-6"
>
<li>
<strong>ForgeRouter:</strong> HTTP routes,
controllers, middleware, and responses
(Step 1).
</li>
<li>
<strong>ForgeView:</strong> views, layouts,
and escaping (Step 1).
</li>
<li>
<strong>ForgeDatabaseSQL + ForgeSqlOrm:</strong>
migrations and models (Step 1).
</li>
<li>
<strong>ForgeAuth + ForgeAppAuth:</strong>
user accounts and the complete auth flow
(Step 2).
</li>
<li>
<strong>ForgeWire:</strong> real-time
interactivity (Step 3).
</li>
<li>
<strong>ForgeEvents:</strong> background
event processing (Step 4).
</li>
<li>
<strong>ForgeTesting:</strong> automated
tests (Step 5).
</li>
</ul>
<h3 class="text-lg font-semibold mb-3">
Prerequisites
</h3>
<ul
class="list-disc list-inside space-y-2 text-gray-600 mb-6"
>
<li>PHP 8.3 or higher</li>
<li>Forge Kernel installed</li>
<li>
Basic PHP and object-oriented programming
</li>
</ul>
<div
class="bg-blue-50 border-l-4 border-blue-400 p-4 mb-6"
>
<p class="text-sm text-blue-700">
<strong>Note:</strong> This tutorial assumes
you've installed Forge Kernel. If not, follow
the
<a
href="getting-started.html"
class="underline"
>Getting Started</a
>
guide first.
</p>
</div>
</section>
<!-- Project Setup -->
<section
id="project-setup"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Project Setup
</h2>
<p class="text-gray-600 mb-6">
We start with a working Forge Kernel project and
a web blueprint. Then we install only the
capabilities Step 1 needs. Everything else
(accounts, reactivity, events, tests) gets added
later, one step at a time.
</p>
<h3 class="text-lg font-semibold mb-3">
Create a Kernel Project
</h3>
<p class="text-gray-600 mb-4">
Install the Kernel and a web blueprint for your
app. The blueprint gives you the structure and a
working <code>forge.php</code> CLI:
</p>
<pre
class="bg-gray-100 p-4 rounded mb-4"
><code class="language-bash"># Install the kernel + a starter web blueprint for a new project
php forge.php package:install-project --blueprint=web</code></pre>
<p class="text-gray-600 mb-4">
This gives you a project with the Kernel, a
<code>public/</code> directory, and the CLI at
<code>forge.php</code>. Verify it works:
</p>
<pre
class="bg-gray-100 p-4 rounded mb-4"
><code class="language-bash"># The Kernel version is available on the CLI
php forge.php --version
# Start the built-in server (ForgeRouter's `serve` command)
php forge.php serve</code></pre>
<p class="text-gray-600 mb-4">
Point your browser at
<code class="bg-gray-100 px-2 py-1 rounded"
>http://localhost:8000</code
>
to confirm the app responds.
</p>
<h3 class="text-lg font-semibold mb-3 mt-6">
Install Step 1 Capabilities
</h3>
<p class="text-gray-600 mb-4">
For the plain todo app we need routing, views,
and a database. Install these four capabilities
with ForgePackageManager:
</p>
<pre
class="bg-gray-100 p-4 rounded mb-4"
><code class="language-bash"># HTTP routing, controllers, and middleware
php forge.php package:install-module --module=forge-router
# Views and layouts
php forge.php package:install-module --module=forge-view
# Database migrations
php forge.php package:install-module --module=forge-database-sql
# Object-relational models
php forge.php package:install-module --module=forge-sql-orm</code></pre>
<p class="text-gray-600 mb-4">
ForgeRouter registers the <code>web</code>
middleware group and the other modules register
what they need. You'll see their middlewares
appear in your
<code class="bg-gray-100 px-2 py-1 rounded"
>config/middleware.php</code
>
file, which controls ordering. Modules register
their own middlewares — this file just
decides the order:
</p>
<pre
class="bg-gray-100 p-4 rounded mb-4"
><code class="language-php"><?php
return [
'global' => [
\Modules\ForgeRouter\Http\Middlewares\ObservabilityMiddleware::class,
],
'web' => [
\Modules\ForgeRouter\Http\Middlewares\SessionMiddleware::class,
\Modules\ForgeRouter\Http\Middlewares\CsrfMiddleware::class,
],
'api' => [],
'auth' => [],
];</code></pre>
<h3 class="text-lg font-semibold mb-3 mt-6">
Project Structure
</h3>
<p class="text-gray-600 mb-4">
By the end of Step 1, our app will have this
structure. (Later steps add accounts, reactive
updates, events, and tests.)
</p>
<pre
class="bg-gray-100 p-4 rounded mb-4"
><code class="language-bash">app/
├── Controllers/
│ └── TodoController.php
├── Models/
│ └── Todo.php
├── Database/
│ └── Migrations/
│ └── 2025_01_01_000000_CreateTodosTable.php
└── resources/
└── views/
├── layouts/
│ └── main.php
└── todos/
└── index.php</code></pre>
<h3 class="text-lg font-semibold mb-3 mt-6">
Environment Configuration
</h3>
<p class="text-gray-600 mb-4">
Ensure your
<code class="bg-gray-100 px-2 py-1 rounded"
>.env</code
>
file points at a database. SQLite is the default
and needs no separate server:
</p>
<pre
class="bg-gray-100 p-4 rounded mb-4"
><code class="language-bash">APP_ENV=local
APP_DEBUG=true
DB_DRIVER=sqlite
DB_DATABASE=storage/database/database.sqlite</code></pre>
</section>
<!-- Step 1: Plain Todo App -->
<section
id="step-1-plain-app"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Step 1: A Plain Todo App
</h2>
<p class="text-gray-600 mb-6">
In this step we build a normal, working todo app
with no accounts, no real-time updates and no
JavaScript magic. It's just HTML forms that POST
to controller methods, touch the database, and
redirect back. This is the foundation everything
else builds on.
</p>
<h3 class="text-lg font-semibold mb-3">
Create the Migration
</h3>
<p class="text-gray-600 mb-4">
Generate a migration for the
<code class="bg-gray-100 px-2 py-1 rounded"
>todos</code
>
table. The Kernel provides a
<code class="bg-gray-100 px-2 py-1 rounded"
>generate:migration</code
>
command:
</p>
<pre
class="bg-gray-100 p-4 rounded mb-4"
><code class="language-bash">php forge.php generate:migration --table=todos --name=CreateTodosTable</code></pre>
<p class="text-gray-600 mb-4">
ForgeDatabaseSQL describes schema with
attributes on the migration class: a
<code class="bg-gray-100 px-2 py-1 rounded"
>#[Table]</code
>
attribute on the class and a
<code class="bg-gray-100 px-2 py-1 rounded"
>#[Column]</code
>
attribute per property. The generated file lives
at
<code class="bg-gray-100 px-2 py-1 rounded"
>app/Database/Migrations/</code
>:
</p>
<pre
class="bg-gray-100 p-4 rounded mb-4"
><code class="language-php"><?php
declare(strict_types=1);
namespace App\Database\Migrations;
use Modules\ForgeDatabaseSQL\DB\Attributes\Column;
use Modules\ForgeDatabaseSQL\DB\Attributes\Index;
use Modules\ForgeDatabaseSQL\DB\Attributes\Table;
use Modules\ForgeDatabaseSQL\DB\Enums\ColumnType;
use Modules\ForgeDatabaseSQL\DB\Migrations\Migration;
#[Table(name: 'todos')]
#[Index(columns: ['title'], name: 'idx_todos_title')]
class CreateTodosTable extends Migration
{
#[Column(name: 'id', type: ColumnType::INTEGER, primaryKey: true, autoIncrement: true)]
public readonly int $id;
#[Column(name: 'title', type: ColumnType::STRING)]
public readonly string $title;
#[Column(name: 'description', type: ColumnType::TEXT, nullable: true)]
public readonly ?string $description;
#[Column(name: 'completed', type: ColumnType::BOOLEAN, default: false)]
public readonly bool $completed;
#[Column(name: 'created_at', type: ColumnType::DATETIME, nullable: true)]
public readonly ?string $createdAt;
#[Column(name: 'updated_at', type: ColumnType::DATETIME, nullable: true)]
public readonly ?string $updatedAt;
}</code></pre>
<p class="text-gray-600 mb-4">
The base <code>Migration</code> class reads
these attributes and generates the SQL for you,
so there's no <code>up()</code>/<code>down()</code>
boilerplate to write. Run the migration:
</p>
<pre
class="bg-gray-100 p-4 rounded mb-4"
><code class="language-bash">php forge.php db:migrate --type=app</code></pre>
<h3 class="text-lg font-semibold mb-3 mt-6">
Create the Model
</h3>
<p class="text-gray-600 mb-4">
ForgeSqlOrm maps rows to plain PHP objects. The
model points at the table with a
<code class="bg-gray-100 px-2 py-1 rounded"
>#[Table]</code
>
attribute and maps each column with
<code class="bg-gray-100 px-2 py-1 rounded"
>#[Column]</code
>. Create
<code class="bg-gray-100 px-2 py-1 rounded"
>app/Models/Todo.php</code
>:
</p>
<pre
class="bg-gray-100 p-4 rounded mb-4"
><code class="language-php"><?php
declare(strict_types=1);
namespace App\Models;
use Modules\ForgeSqlOrm\ORM\Attributes\Column;
use Modules\ForgeSqlOrm\ORM\Attributes\Table;
use Modules\ForgeSqlOrm\ORM\Model;
use Modules\ForgeSqlOrm\ORM\Values\Cast;
use Modules\ForgeSqlOrm\Traits\HasTimeStamps;
#[Table('todos')]
class Todo extends Model
{
use HasTimeStamps;
#[Column(primary: true, cast: Cast::INT)]
public ?int $id = null;
#[Column(cast: Cast::STRING)]
public string $title;
#[Column(cast: Cast::STRING)]
public ?string $description = null;
#[Column(cast: Cast::BOOL)]
public bool $completed = false;
}</code></pre>
<p class="text-gray-600 mb-4">
The model gives you
<code class="bg-gray-100 px-2 py-1 rounded"
>save()</code
>,
<code class="bg-gray-100 px-2 py-1 rounded"
>delete()</code
>, and a query builder via
<code class="bg-gray-100 px-2 py-1 rounded"
>Todo::query()</code
>
so you can find, order, and filter rows.
</p>
<h3 class="text-lg font-semibold mb-3 mt-6">
Create the Controller
</h3>
<p class="text-gray-600 mb-4">
ForgeRouter maps HTTP routes to controller
methods with the
<code class="bg-gray-100 px-2 py-1 rounded"
>#[Endpoint]</code
>
attribute. Controllers are plain classes —
there's no base class — and they pull in
the
<code class="bg-gray-100 px-2 py-1 rounded"
>ViewHelper</code
>
trait to render views. Create
<code class="bg-gray-100 px-2 py-1 rounded"
>app/Controllers/TodoController.php</code
>:
</p>
<pre
class="bg-gray-100 p-4 rounded mb-4"
><code class="language-php"><?php
declare(strict_types=1);
namespace App\Controllers;
use App\Models\Todo;
use Forge\Core\Helpers\Flash;
use Modules\ForgeRouter\Attributes\Layout;
use Modules\ForgeRouter\Attributes\Routable;
use Modules\ForgeRouter\Helpers\Redirect;
use Modules\ForgeRouter\Http\Attributes\UseMiddleware;
use Modules\ForgeRouter\Http\Request;
use Modules\ForgeRouter\Http\Response;
use Modules\ForgeRouter\Routing\Endpoint;
use Modules\ForgeView\Traits\ViewHelper;
#[Routable]
#[UseMiddleware('web')]
final class TodoController
{
use ViewHelper;
#[Endpoint('/todos')]
#[Layout('main')]
public function index(Request $request): Response
{
$todos = Todo::query()->orderBy('id', 'DESC')->get();
return $this->view('todos/index', ['todos' => $todos]);
}
#[Endpoint('/todos', 'POST')]
public function store(Request $request): Response
{
$title = trim((string) $request->input('title'));
if ($title === '') {
Flash::set('error', 'Title is required');
return Redirect::to('/todos');
}
$todo = new Todo();
$todo->title = $title;
$todo->description = $request->input('description');
$todo->completed = false;
$todo->save();
Flash::set('success', 'Todo created');
return Redirect::to('/todos');
}
#[Endpoint('/todos/{id}/toggle', 'POST')]
public function toggle(int $id): Response
{
$todo = Todo::query()->id($id)->first();
if ($todo) {
$todo->completed = !$todo->completed;
$todo->save();
}
return Redirect::to('/todos');
}
#[Endpoint('/todos/{id}', 'DELETE')]
public function destroy(int $id): Response
{
Todo::query()->id($id)->first()?->delete();
Flash::set('success', 'Todo deleted');
return Redirect::to('/todos');
}
}</code></pre>
<p class="text-gray-600 mb-4">
A few things to notice:
</p>
<ul
class="list-disc list-inside space-y-2 text-gray-600 mb-6"
>
<li>
<code class="bg-gray-100 px-2 py-1 rounded"
>#[Routable]</code
>
marks the class as a controller.
</li>
<li>
<code class="bg-gray-100 px-2 py-1 rounded"
>#[Endpoint(path, method)]</code
>
maps a route. Route parameters such as
<code class="bg-gray-100 px-2 py-1 rounded"
>{id}</code
>
are injected into the method by name.
</li>
<li>
<code class="bg-gray-100 px-2 py-1 rounded"
>#[UseMiddleware('web')]</code
>
applies the session and CSRF middleware
group to every route on this controller.
</li>
<li>
A method parameter named
<code class="bg-gray-100 px-2 py-1 rounded"
>request</code
>
receives the current
<code class="bg-gray-100 px-2 py-1 rounded"
>Request</code
>
— <code>$request->input('title')</code>
reads form data.
</li>
</ul>
<h3 class="text-lg font-semibold mb-3 mt-6">
Create the Views
</h3>
<p class="text-gray-600 mb-4">
ForgeView renders PHP templates. The
<code class="bg-gray-100 px-2 py-1 rounded"
>#[Layout('main')]</code
>
attribute picks the layout, which receives the
page content as
<code class="bg-gray-100 px-2 py-1 rounded"
>$content</code
>. First, the layout at
<code class="bg-gray-100 px-2 py-1 rounded"
>app/resources/views/layouts/main.php</code
>:
</p>
<pre
class="bg-gray-100 p-4 rounded mb-4"
><code class="language-php"><!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title><?= e($layoutProps['title'] ?? 'Todos') ?></title>
<link rel="stylesheet" href="/assets/css/app.css">
<?= raw(csrf_meta()) ?>
</head>
<body class="bg-gray-50">
<main class="max-w-4xl mx-auto px-4 py-8">
<?php if (Flash::has('success')): ?>
<div class="bg-green-50 border border-green-200 text-green-800 px-4 py-3 rounded mb-4">
<?= e(Flash::get('success')) ?>
</div>
<?php endif; ?>
<?php if (Flash::has('error')): ?>
<div class="bg-red-50 border border-red-200 text-red-800 px-4 py-3 rounded mb-4">
<?= e(Flash::get('error')) ?>
</div>
<?php endif; ?>
<?= $content ?>
</main>
</body>
</html></code></pre>
<p class="text-gray-600 mb-4 mt-6">
Now the todos index view at
<code class="bg-gray-100 px-2 py-1 rounded"
>app/resources/views/todos/index.php</code
>:
</p>
<pre
class="bg-gray-100 p-4 rounded mb-4"
><code class="language-php"><h1 class="text-2xl font-bold mb-6">My Todos</h1>
<form method="POST" action="/todos" class="mb-6 flex gap-4">
<?= raw(csrf_input()) ?>
<input type="text" name="title" placeholder="Todo title..." required
class="flex-1 px-4 py-2 border border-gray-300 rounded-md">
<input type="text" name="description" placeholder="Description (optional)"
class="flex-1 px-4 py-2 border border-gray-300 rounded-md">
<button type="submit" class="px-6 py-2 bg-blue-600 text-white rounded-md">
Add Todo
</button>
</form>
<div class="space-y-3">
<?php foreach ($todos as $todo): ?>
<div class="flex items-center gap-4 p-4 border border-gray-200 rounded-md
<?= $todo->completed ? 'bg-gray-50' : 'bg-white' ?>">
<div class="flex-1">
<h3 class="font-semibold <?= $todo->completed ? 'line-through text-gray-500' : 'text-gray-900' ?>">
<?= e($todo->title) ?>
</h3>
<?php if ($todo->description): ?>
<p class="text-sm text-gray-600 mt-1"><?= e($todo->description) ?></p>
<?php endif; ?>
</div>
<form method="POST" action="/todos/<?= $todo->id ?>/toggle" class="inline">
<?= raw(csrf_input()) ?>
<button type="submit"
class="px-4 py-2 <?= $todo->completed ? 'bg-yellow-600' : 'bg-green-600' ?> text-white rounded-md">
<?= $todo->completed ? 'Undo' : 'Complete' ?>
</button>
</form>
<form method="POST" action="/todos/<?= $todo->id ?>" class="inline">
<?= raw(csrf_input()) ?>
<input type="hidden" name="_method" value="DELETE">
<button type="submit"
class="px-4 py-2 bg-red-600 text-white rounded-md"
onclick="return confirm('Are you sure?')">
Delete
</button>
</form>
</div>
<?php endforeach; ?>
<?php if (empty($todos)): ?>
<p class="text-gray-500 text-center py-8">No todos yet. Create your first one above!</p>
<?php endif; ?>
</div></code></pre>
<h3 class="text-lg font-semibold mb-3 mt-6">
Try It
</h3>
<p class="text-gray-600 mb-4">
Start the server and visit
<code class="bg-gray-100 px-2 py-1 rounded"
>http://localhost:8000/todos</code
>. You can add, complete, and delete todos with
plain browser navigation. Nothing is
JavaScript-driven yet — and that's exactly
the point. It works.
</p>
<pre
class="bg-gray-100 p-4 rounded mb-4"
><code class="language-bash">php forge.php serve</code></pre>
<div
class="bg-blue-50 border-l-4 border-blue-400 p-4 mb-6"
>
<p class="text-sm text-blue-700">
<strong>What we did:</strong> the Kernel let
us assemble a routing capability, a view
capability, and a data capability into a
working app. We added no framework — we
just plugged capabilities into the kernel.
</p>
</div>
</section>
<!-- Step 2: Add User Accounts -->
<section
id="step-2-accounts"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Step 2: Add User Accounts
</h2>
<p class="text-gray-600 mb-6">
Our todo app works, but anyone can edit anyone's
todos. Let's add user accounts so each user only
sees their own items. <strong>ForgeAppAuth</strong>
is the distributable auth capability: it ships the
User model, the
<code class="bg-gray-100 px-2 py-1 rounded"
>auth</code
>
middleware, and the complete account flow with
registration, login, logout, password reset, and
recovery — all ready to wire into your app.
</p>
<h3 class="text-lg font-semibold mb-3">
Install ForgeAppAuth
</h3>
<pre
class="bg-gray-100 p-4 rounded mb-4"
><code class="language-bash">php forge.php package:install-module --module=forge-app-auth</code></pre>
<p class="text-gray-600 mb-4">
ForgeAppAuth depends on the
<code class="bg-gray-100 px-2 py-1 rounded"
>forge-auth</code
>
service (already installed) plus the router, view,
database, and ORM capabilities you already have, so
one command is all it takes. It brings the
<code class="bg-gray-100 px-2 py-1 rounded"
>users</code
>
table migration (it runs
<code class="bg-gray-100 px-2 py-1 rounded"
>db:migrate</code
>
on install) and the
<code class="bg-gray-100 px-2 py-1 rounded"
>User</code
>
model at
<code class="bg-gray-100 px-2 py-1 rounded"
>Modules\ForgeAppAuth\Models\User</code
>. It also ships the
<code class="bg-gray-100 px-2 py-1 rounded"
>Modules\ForgeAppAuth\Middlewares\AuthMiddleware
</code
>; add it to the
<code class="bg-gray-100 px-2 py-1 rounded"
>auth</code
>
group in
<code class="bg-gray-100 px-2 py-1 rounded"
>config/middleware.php</code
>, and protect routes with
<code class="bg-gray-100 px-2 py-1 rounded"
>#[UseMiddleware(['web', 'auth'])]</code
>:
</p>
<pre
class="bg-gray-100 p-4 rounded mb-4"
><code class="language-php"><?php
return [
"web" => [
\Modules\ForgeRouter\Http\Middlewares\SessionMiddleware::class,
\Modules\ForgeRouter\Http\Middlewares\CsrfMiddleware::class,
],
"auth" => [
\Modules\ForgeAppAuth\Middlewares\AuthMiddleware::class,
],
];</code></pre>
<h3 class="text-lg font-semibold mb-3 mt-6">
Give Todos an Owner
</h3>
<p class="text-gray-600 mb-4">
Generate a migration that adds a
<code class="bg-gray-100 px-2 py-1 rounded"
>user_id</code
>
column to the
<code class="bg-gray-100 px-2 py-1 rounded"
>todos</code
>
table:
</p>