-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathforge-sql-orm.html
More file actions
633 lines (604 loc) · 30.9 KB
/
Copy pathforge-sql-orm.html
File metadata and controls
633 lines (604 loc) · 30.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
<!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 - ForgeSqlOrm</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">
ForgeSqlOrm
</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="#when-to-use"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>When to Reach for It</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
>
<a
href="#models"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Models</a
>
<a
href="#queries"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Queries</a
>
<a
href="#saving-and-deleting"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Saving & Deleting</a
>
<a
href="#casts-and-relationships"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Casts & Relationships</a
>
<a
href="#soft-deletes"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Soft Deletes</a
>
<a
href="#repositories-and-caching"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Repositories & Caching</a
>
<a
href="#pagination"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Pagination</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-database-sql.html"
class="block text-gray-600 hover:text-blue-600 py-1 text-sm"
>ForgeDatabaseSQL — the connection it builds on →</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">
ForgeSqlOrm
</h1>
<p class="text-xl text-gray-600 mb-4">
A component that gives <strong>your app</strong> an
object-style layer over your SQL database: models map
rows to classes, and a fluent query builder handles
reads, writes, relations, soft deletes, and
pagination. It builds on
<a href="forge-database-sql.html" class="text-blue-600 underline">ForgeDatabaseSQL</a>
for the underlying connection.
</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">
This is another component <em>your app</em>
chooses to use — not a layer you inherit. If you
like working with your data as PHP objects and a
fluent query interface instead of writing raw SQL,
this capability gives you that. You still decide
which models exist, how they're shaped, and what
your app does with them.
</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-driven models mapped to tables</li>
<li>A fluent query builder for your app's data</li>
<li>Relations, casts, and soft deletes</li>
<li>Pagination helpers and views</li>
</ul>
<ul class="space-y-2 list-disc list-inside">
<li>Optional query result caching</li>
<li>UUID or auto-increment primary keys</li>
<li>Automatic timestamps when columns exist</li>
</ul>
</div>
</div>
<div
class="bg-green-50 border-l-4 border-green-400 p-4"
>
<p class="text-sm text-green-700">
<strong>Core capability:</strong>
ForgeSqlOrm ships as a core capability
(<code>type: core</code>, loaded after
ForgeDatabaseSQL at <code>order: 1</code>). It
<em>requires</em> a database connection
(<code>DatabaseConnectionInterface</code>) and
provides the
<code>QueryBuilderInterface</code> to your app.
</p>
</div>
</section>
<!-- When to Reach for It -->
<section id="when-to-use" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">
When to Reach for It
</h2>
<ul class="list-disc list-inside space-y-2 text-gray-600 mb-4">
<li>Your app models its data as objects and relations.</li>
<li>You want type-safe, casted columns (dates, enums, JSON).</li>
<li>You want soft deletes and pagination without reinventing them.</li>
<li>You'd rather query fluently than hand-write SQL.</li>
</ul>
<p class="text-gray-600">
If you prefer raw SQL, or your app only needs a
couple of hand-written queries, you can skip this
and use the
<a href="forge-database-sql.html#using-the-connection" class="text-blue-600 underline">connection from ForgeDatabaseSQL</a>
directly. It's your call — these are components.
</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">
A core capability, so usually present. If your
project needs it, install it like any capability:
</p>
<div
class="code-block p-6 text-white rounded-lg mb-4"
>
<pre><code class="language-bash">php forge.php package:install-module --module=ForgeSqlOrm</code></pre>
</div>
<p class="text-gray-600">
It requires ForgeDatabaseSQL to be installed and
configured first.
</p>
</section>
<!-- Models -->
<section id="models" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Models
</h2>
<p class="text-gray-600 mb-4">
A model is a class that extends the base
<code>Model</code>, declares its table, and maps
columns to typed properties. You add these to your
app wherever you keep your domain code.
</p>
<div
class="code-block p-6 text-white rounded-lg mb-4"
>
<pre><code class="language-php">use Modules\ForgeSqlOrm\ORM\Model;
use Modules\ForgeSqlOrm\ORM\Attributes\Table;
use Modules\ForgeSqlOrm\ORM\Attributes\Column;
use Modules\ForgeSqlOrm\ORM\Attributes\Hidden;
use Modules\ForgeSqlOrm\ORM\Values\Cast;
#[Table('users')]
class User extends Model
{
#[Column(primary: true)]
public int $id;
#[Column]
public string $email;
#[Column(cast: Cast::JSON)]
public ?array $preferences;
#[Column]
#[Hidden]
public string $password;
}</code></pre>
</div>
<p class="text-gray-600">
The base handles the mapping for you: a string
primary key is treated as a UUID (auto-generated
on insert), and <code>created_at</code> /
<code>updated_at</code> are maintained
automatically when those properties exist.
Columns marked <code>#[Hidden]</code> are dropped
from <code>toArray()</code> serialization.
</p>
</section>
<!-- Queries -->
<section id="queries" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Queries
</h2>
<p class="text-gray-600 mb-4">
Use the static entry points on your model to build
queries:
</p>
<div
class="code-block p-6 text-white rounded-lg mb-4"
>
<pre><code class="language-php">$user = User::query()->where('email', $email)->first();
$recent = User::query()
->where('active', 1)
->orderBy('created_at', 'DESC')
->limit(10)
->get();
$count = User::query()->count();
$byIds = User::query()->whereIn('id', [1, 2, 3])->get();</code></pre>
</div>
<p class="text-gray-600 mb-4">
There are convenience shortcuts on the model:
</p>
<div
class="code-block p-6 text-white rounded-lg mb-6"
>
<pre><code class="language-php">$newest = User::latest()->first(); // newest first
$oldest = User::oldest()->first(); // oldest first</code></pre>
</div>
</section>
<!-- Saving and Deleting -->
<section
id="saving-and-deleting"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Saving & Deleting
</h2>
<p class="text-gray-600 mb-4">
New instances save with <code>save()</code>, which
inserts or updates based on whether the row already
exists. Existing rows update only their changed
columns.
</p>
<div
class="code-block p-6 text-white rounded-lg mb-4"
>
<pre><code class="language-php">$user = new User();
$user->email = 'ada@example.com';
$user->save(); // INSERT
$user->preferences = ['theme' => 'dark'];
$user->save(); // UPDATE (only changed columns)
$user->delete(); // delete, or soft-delete if enabled</code></pre>
</div>
<p class="text-gray-600">
You can also operate without loading an instance,
using
<code>insert()</code>, <code>insertMany()</code>,
<code>update()</code>, and <code>forceDelete()</code>
on the query builder.
</p>
</section>
<!-- Casts and Relationships -->
<section
id="casts-and-relationships"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Casts & Relationships
</h2>
<h3 class="text-lg font-semibold mb-3">Casts</h3>
<p class="text-gray-600 mb-4">
Mark a column with <code>#[Column(cast: ...)]</code>
to have the ORM convert values in and out of the
database. Supported casts:
<code>INT</code>, <code>FLOAT</code>,
<code>BOOL</code>, <code>STRING</code>,
<code>JSON</code>, <code>DATE</code>,
<code>DATETIME</code>, <code>TIMESTAMP</code>, and
<code>ENUM</code>.
</p>
<h3 class="text-lg font-semibold mb-3">
Relationships
</h3>
<p class="text-gray-600 mb-4">
Eager-load relations with <code>with()</code> and
access them on the model. You define how relations
are resolved in your model; this loads them without
N+1 queries:
</p>
<div
class="code-block p-6 text-white rounded-lg mb-6"
>
<pre><code class="language-php">$posts = Post::with('author', 'comments')->whereIn('id', $ids)->get();
foreach ($posts as $post) {
echo $post->author->name; // already loaded, no extra query
}</code></pre>
</div>
</section>
<!-- Soft Deletes -->
<section
id="soft-deletes"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Soft Deletes
</h2>
<p class="text-gray-600 mb-4">
Give a model a <code>deleted_at</code> property and
deletes become soft: rows are flagged, not removed.
The
<code>SoftDeletes</code> trait provides the column
for you:
</p>
<div
class="code-block p-6 text-white rounded-lg mb-4"
>
<pre><code class="language-php">use Modules\ForgeSqlOrm\ORM\Model;
use Modules\ForgeSqlOrm\ORM\Traits\SoftDeletes;
#[Table('posts')]
class Post extends Model
{
use SoftDeletes; // adds $deleted_at column
}</code></pre>
</div>
<p class="text-gray-600 mb-4">
Queries exclude soft-deleted rows by default:
</p>
<div
class="code-block p-6 text-white rounded-lg mb-6"
>
<pre><code class="language-php">Post::query()->withTrashed()->get(); // include deleted
Post::query()->onlyTrashed()->get(); // only deleted
$post->forceDelete(); // remove for real</code></pre>
</div>
</section>
<!-- Repositories and Caching -->
<section
id="repositories-and-caching"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Repositories & Caching
</h2>
<h3 class="text-lg font-semibold mb-3">
Repositories
</h3>
<p class="text-gray-600 mb-4">
For app code that prefers not to call the model
directly, the capability ships a small repository
interface with the usual
<code>create</code>, <code>update</code>,
<code>delete</code>, <code>find</code>,
<code>findBy</code>, <code>findAll</code>, and
<code>query</code> operations.
</p>
<h3 class="text-lg font-semibold mb-3">
Query caching
</h3>
<p class="text-gray-600">
A <code>QueryCache</code> is available in the
container (default TTL 3600s) with
<code>get</code>, <code>set</code>,
<code>forget</code>, and <code>invalidate</code>
operations so you can cache query results when it
makes sense for your app.
</p>
</section>
<!-- Pagination -->
<section id="pagination" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Pagination
</h2>
<p class="text-gray-600 mb-4">
Paginate a model directly and render the links with
the included helpers:
</p>
<div
class="code-block p-6 text-white rounded-lg mb-4"
>
<pre><code class="language-php">$users = User::paginate(
page: 2,
perPage: 20,
column: 'created_at',
direction: 'DESC'
);
</code></pre>
</div>
<div
class="code-block p-6 text-white rounded-lg mb-4"
>
<pre><code class="language-php">// In a view: render the pager and summary
<?= paginate($users) ?>
<?= pagination_info($users) ?>
</code></pre>
</div>
<p class="text-gray-600">
The <code>pagination()</code>,
<code>paginate()</code>, and
<code>pagination_info()</code> helpers are provided
by this capability.
</p>
</section>
</div>
</div>
</div>
</div>
<!-- Footer -->
<footer class="bg-gray-900 text-white py-8 mt-16">
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8 text-center">
<div class="mb-4">
<span class="text-lg font-bold">Forge Kernel</span>
</div>
<p class="text-gray-400">
A toolbox for builders who like to do things their way.
</p>
</div>
</footer>
<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>
</html>