Skip to content

Commit 97c8d1d

Browse files
author
flow-php
committed
1 parent c616002 commit 97c8d1d

File tree

92 files changed

+783
-783
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

92 files changed

+783
-783
lines changed

assets/manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@
148148
"wasm\/php.js": "\/assets\/wasm\/php-efe717082103712187d38a1e0aecf4a5.js",
149149
"wasm\/php.wasm": "\/assets\/wasm\/php-8f0f307bdd99263d3102236b035d9d5f.wasm",
150150
"wasm\/phpcsfixer.php.wasm": "\/assets\/wasm\/phpcsfixer.php-65bf51f1ea90e4896971e11e62efef0b.wasm",
151-
"wasm\/tools\/flow.phar": "\/assets\/wasm\/tools\/flow-1cf7b41851c7d1b492cdab22569d21df.phar",
151+
"wasm\/tools\/flow.phar": "\/assets\/wasm\/tools\/flow-1236d375074ea60e9ee028141484a77b.phar",
152152
"wasm\/tools\/php-cs-fixer.phar": "\/assets\/wasm\/tools\/php-cs-fixer-de55dbd75a08d2eac0f0435d4168e6bc.phar",
153153
"wasm\/vendor\/autoload.php.wasm": "\/assets\/wasm\/vendor\/autoload.php-901f7714ee4a437fea3a9d6638722933.wasm"
154154
}

assets/wasm/tools/flow-1cf7b41851c7d1b492cdab22569d21df.phar renamed to assets/wasm/tools/flow-1236d375074ea60e9ee028141484a77b.phar

2.49 MB
Binary file not shown.

changelog/index.html

Lines changed: 240 additions & 240 deletions
Large diffs are not rendered by default.

data_frame/data_writing/database_delete/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -478,7 +478,7 @@ <h2 class="text-xl mt-5">Description</h2>
478478
class="rounded px-4 pt-4 overflow-auto shadow-2xl shadow-gray rounded border-gray border-2 relative mb-5"
479479
data-controller="all-links-external"
480480
>
481-
<h1><a id="flow-php-delete-rows-from-the-database-that-are-matching-rows-in-the-dataframe" href="#content-delete-rows-from-the-database-that-are-matching-rows-in-the-dataframe" class="mr-2" aria-hidden="true" title="Permalink">#</a>Delete rows from the database that are matching rows in the DataFrame.</h1>
481+
<h1><a id="delete-rows-from-the-database-that-are-matching-rows-in-the-dataframe" href="#delete-rows-from-the-database-that-are-matching-rows-in-the-dataframe" class="mr-2" aria-hidden="true" title="Permalink">#</a>Delete rows from the database that are matching rows in the DataFrame.</h1>
482482
<ul>
483483
<li><code>to_dbal_table_delete(...)</code></li>
484484
</ul>

data_frame/data_writing/database_upsert/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -478,7 +478,7 @@ <h2 class="text-xl mt-5">Description</h2>
478478
class="rounded px-4 pt-4 overflow-auto shadow-2xl shadow-gray rounded border-gray border-2 relative mb-5"
479479
data-controller="all-links-external"
480480
>
481-
<h1><a id="flow-php-upsert-insert-or-update-data-into-a-database" href="#content-upsert-insert-or-update-data-into-a-database" class="mr-2" aria-hidden="true" title="Permalink">#</a>Upsert (insert or update) data into a database</h1>
481+
<h1><a id="upsert-insert-or-update-data-into-a-database" href="#upsert-insert-or-update-data-into-a-database" class="mr-2" aria-hidden="true" title="Permalink">#</a>Upsert (insert or update) data into a database</h1>
482482
<p>There are two ways to update data in the database:</p>
483483
<ul>
484484
<li><code>to_dbal_table_insert(...)</code></li>

documentation/adrs/extension-points/index.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -427,10 +427,10 @@ <h1 class="hidden lg:block">
427427
</a>
428428
</div>
429429

430-
<h1><a id="flow-php-extension-points" href="#content-extension-points" class="mr-2" aria-hidden="true" title="Permalink">#</a>Extension Points</h1>
430+
<h1><a id="extension-points" href="#extension-points" class="mr-2" aria-hidden="true" title="Permalink">#</a>Extension Points</h1>
431431
<p>Proposed by: <a rel="noopener noreferrer" target="_blank" href="https://github.com/norberttech">@norberttech</a><br />
432432
Date: 2025-01-09</p>
433-
<h2><a id="flow-php-context" href="#content-context" class="mr-2" aria-hidden="true" title="Permalink">#</a>Context</h2>
433+
<h2><a id="context" href="#context" class="mr-2" aria-hidden="true" title="Permalink">#</a>Context</h2>
434434
<hr />
435435
<p>Flow is a framework, and as all frameworks, it should provide extension points for developers to hook into the framework and extend its functionality.</p>
436436
<p>How to find an extension point?</p>
@@ -447,7 +447,7 @@ <h2><a id="flow-php-context" href="#content-context" class="mr-2" aria-hidden="t
447447
<p>Why? Because nothing prevents developers from extending those classes and injecting
448448
their custom version into the DataFrame.</p>
449449
<p>Those extension points can't be covered by our backward compatibility policy.</p>
450-
<h2><a id="flow-php-decision" href="#content-decision" class="mr-2" aria-hidden="true" title="Permalink">#</a>Decision</h2>
450+
<h2><a id="decision" href="#decision" class="mr-2" aria-hidden="true" title="Permalink">#</a>Decision</h2>
451451
<hr />
452452
<p><strong>Closed by default</strong></p>
453453
<p>All classes should be marked as <code>final</code> and whenever we need to expose an extension point,
@@ -461,7 +461,7 @@ <h2><a id="flow-php-decision" href="#content-decision" class="mr-2" aria-hidden=
461461
but we do not guarantee backward compatibility for those cases and everyone should
462462
do it at their own risk. As a Flow PHP maintainers, we also reserve the right to
463463
not provide any help or support for those cases.</p>
464-
<h2><a id="flow-php-pros--cons" href="#content-pros--cons" class="mr-2" aria-hidden="true" title="Permalink">#</a>Pros &amp; Cons</h2>
464+
<h2><a id="pros--cons" href="#pros--cons" class="mr-2" aria-hidden="true" title="Permalink">#</a>Pros &amp; Cons</h2>
465465
<hr />
466466
<ul>
467467
<li>zero risk of breaking accidentally backward compatibility promise</li>
@@ -470,14 +470,14 @@ <h2><a id="flow-php-pros--cons" href="#content-pros--cons" class="mr-2" aria-hid
470470
<li>easier to find an actual extension points</li>
471471
<li>impossible to mock classes that aren’t marked as <code>final</code> in tests (which is a good thing, users shouldn’t mock Flow classes in their test suites)</li>
472472
</ul>
473-
<h2><a id="flow-php-alternatives-considered-optional" href="#content-alternatives-considered-optional" class="mr-2" aria-hidden="true" title="Permalink">#</a>Alternatives Considered (optional)</h2>
473+
<h2><a id="alternatives-considered-optional" href="#alternatives-considered-optional" class="mr-2" aria-hidden="true" title="Permalink">#</a>Alternatives Considered (optional)</h2>
474474
<hr />
475475
<p>Alternatively we could take similar approach to Symfony and mark classes as <code>final</code>
476476
<a rel="noopener noreferrer" target="_blank" href="https://github.com/symfony/symfony/issues/15233#issuecomment-1566682054">when it makes sense</a>
477477
but this approach is too easy to get abused.</p>
478478
<p>Plus, changing non-final class into a final one is much bigger BC break
479479
then the other way around.</p>
480-
<h2><a id="flow-php-links-and-references-optional" href="#content-links-and-references-optional" class="mr-2" aria-hidden="true" title="Permalink">#</a>Links and References (optional)</h2>
480+
<h2><a id="links-and-references-optional" href="#links-and-references-optional" class="mr-2" aria-hidden="true" title="Permalink">#</a>Links and References (optional)</h2>
481481
<hr />
482482
<ul>
483483
<li><a rel="noopener noreferrer" target="_blank" href="https://ocramius.github.io/blog/when-to-declare-classes-final/">When to declare classes final</a></li>

documentation/adrs/index.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -427,8 +427,8 @@ <h1 class="hidden lg:block">
427427
</a>
428428
</div>
429429

430-
<h1><a id="flow-php-architecture-decision-record" href="#content-architecture-decision-record" class="mr-2" aria-hidden="true" title="Permalink">#</a>Architecture Decision Record</h1>
431-
<h1><a id="flow-php-what-are-adrs" href="#content-what-are-adrs" class="mr-2" aria-hidden="true" title="Permalink">#</a>What are ADRs?</h1>
430+
<h1><a id="architecture-decision-record" href="#architecture-decision-record" class="mr-2" aria-hidden="true" title="Permalink">#</a>Architecture Decision Record</h1>
431+
<h1><a id="what-are-adrs" href="#what-are-adrs" class="mr-2" aria-hidden="true" title="Permalink">#</a>What are ADRs?</h1>
432432
<p>Architecture Decision Records (ADRs) are structured documents that capture significant architectural decisions made during the development of this project.</p>
433433
<p>Each ADR explains:</p>
434434
<ul>
@@ -437,7 +437,7 @@ <h1><a id="flow-php-what-are-adrs" href="#content-what-are-adrs" class="mr-2" ar
437437
<li><strong>The consequences</strong>: The impact of the decision, both positive and negative.</li>
438438
</ul>
439439
<p>ADRs act as a single source of truth for important design and architectural choices, ensuring that everyone involved in the project has a shared understanding of why things are the way they are.</p>
440-
<h2><a id="flow-php-how-to-use-adrs-in-this-project" href="#content-how-to-use-adrs-in-this-project" class="mr-2" aria-hidden="true" title="Permalink">#</a>How to Use ADRs in This Project</h2>
440+
<h2><a id="how-to-use-adrs-in-this-project" href="#how-to-use-adrs-in-this-project" class="mr-2" aria-hidden="true" title="Permalink">#</a>How to Use ADRs in This Project</h2>
441441
<p><strong>Follow Existing ADRs</strong>: ADRs are mandatory to follow unless explicitly overridden by a new ADR. This ensures consistency in decision-making across the project.</p>
442442
<blockquote>
443443
<p>Whenever ADR is merged into the main branch, it is considered accepted and must be followed by all contributors.</p>
@@ -449,14 +449,14 @@ <h2><a id="flow-php-how-to-use-adrs-in-this-project" href="#content-how-to-use-a
449449
<li>Submit the ADR via a pull request and engage in a discussion with maintainers and contributors.</li>
450450
<li><strong>Document Decisions Transparently</strong>: All significant decisions must be documented. This includes not only what was decided but also the alternatives that were considered and why they were rejected.</li>
451451
</ul>
452-
<h2><a id="flow-php-index-of-adrs" href="#content-index-of-adrs" class="mr-2" aria-hidden="true" title="Permalink">#</a>Index of ADRs</h2>
453-
<h3><a id="flow-php-accepted-ad" href="#content-accepted-ad" class="mr-2" aria-hidden="true" title="Permalink">#</a><a rel="noopener noreferrer" target="_blank" href="https://github.com/flow-php/flow/pulls?q=is%3Apr+is%3Aclosed+is%3Amerged+label%3AAD+">Accepted AD</a></h3>
452+
<h2><a id="index-of-adrs" href="#index-of-adrs" class="mr-2" aria-hidden="true" title="Permalink">#</a>Index of ADRs</h2>
453+
<h3><a id="accepted-ad" href="#accepted-ad" class="mr-2" aria-hidden="true" title="Permalink">#</a><a rel="noopener noreferrer" target="_blank" href="https://github.com/flow-php/flow/pulls?q=is%3Apr+is%3Aclosed+is%3Amerged+label%3AAD+">Accepted AD</a></h3>
454454
<ul>
455455
<li><a href="/documentation/adrs/static-analysis-baseline">2025-01-07: Static Analysis Baseline</a></li>
456456
<li><a href="/documentation/adrs/extension-points">2025-01-09: Extension Points</a></li>
457457
</ul>
458-
<h3><a id="flow-php-proposed-ad" href="#content-proposed-ad" class="mr-2" aria-hidden="true" title="Permalink">#</a><a rel="noopener noreferrer" target="_blank" href="https://github.com/flow-php/flow/pulls?q=is%3Apr+is%3Aopen+label%3AAD+">Proposed AD</a></h3>
459-
<h3><a id="flow-php-rejected-ad" href="#content-rejected-ad" class="mr-2" aria-hidden="true" title="Permalink">#</a><a rel="noopener noreferrer" target="_blank" href="https://github.com/flow-php/flow/pulls?q=is%3Apr+is%3Aclosed+is%3Aunmerged+label%3AAD+">Rejected AD</a></h3>
458+
<h3><a id="proposed-ad" href="#proposed-ad" class="mr-2" aria-hidden="true" title="Permalink">#</a><a rel="noopener noreferrer" target="_blank" href="https://github.com/flow-php/flow/pulls?q=is%3Apr+is%3Aopen+label%3AAD+">Proposed AD</a></h3>
459+
<h3><a id="rejected-ad" href="#rejected-ad" class="mr-2" aria-hidden="true" title="Permalink">#</a><a rel="noopener noreferrer" target="_blank" href="https://github.com/flow-php/flow/pulls?q=is%3Apr+is%3Aclosed+is%3Aunmerged+label%3AAD+">Rejected AD</a></h3>
460460

461461

462462
<hr class="!mt-8 !mb-8"/>

documentation/adrs/static-analysis-baseline/index.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -427,10 +427,10 @@ <h1 class="hidden lg:block">
427427
</a>
428428
</div>
429429

430-
<h1><a id="flow-php-static-analysis-baseline" href="#content-static-analysis-baseline" class="mr-2" aria-hidden="true" title="Permalink">#</a>Static Analysis Baseline</h1>
430+
<h1><a id="static-analysis-baseline" href="#static-analysis-baseline" class="mr-2" aria-hidden="true" title="Permalink">#</a>Static Analysis Baseline</h1>
431431
<p>Proposed by: <a rel="noopener noreferrer" target="_blank" href="https://github.com/norberttech">@norberttech</a>
432432
Date: 2025-01-07</p>
433-
<h2><a id="flow-php-context" href="#content-context" class="mr-2" aria-hidden="true" title="Permalink">#</a>Context</h2>
433+
<h2><a id="context" href="#context" class="mr-2" aria-hidden="true" title="Permalink">#</a>Context</h2>
434434
<hr />
435435
<p>After removal of Psalm and making PHPStan the main static analysis tool,
436436
we looked again into hardening the static analysis configuration.</p>
@@ -449,21 +449,21 @@ <h2><a id="flow-php-context" href="#content-context" class="mr-2" aria-hidden="t
449449
Whenever the code is changed, the baseline needs to be updated, which is an opportunity to also suppress new errors.<br />
450450
This means that maintainers would not only need to go through the code changes
451451
but also through the baseline file, which is not the best use of their very limited and valuable time anyway.</p>
452-
<h2><a id="flow-php-decision" href="#content-decision" class="mr-2" aria-hidden="true" title="Permalink">#</a>Decision</h2>
452+
<h2><a id="decision" href="#decision" class="mr-2" aria-hidden="true" title="Permalink">#</a>Decision</h2>
453453
<hr />
454454
<p>We <strong>must not</strong> use baseline for static analysis.
455455
Instead, errors can be suppressed by annotations in the codebase or globally
456456
in the static analysis tool configuration.</p>
457457
<p>Error suppression should be considered an edge case and should be used sparingly.
458458
Core contributors should review and approve all suppression annotations.</p>
459-
<h2><a id="flow-php-pros--cons" href="#content-pros--cons" class="mr-2" aria-hidden="true" title="Permalink">#</a>Pros &amp; Cons</h2>
459+
<h2><a id="pros--cons" href="#pros--cons" class="mr-2" aria-hidden="true" title="Permalink">#</a>Pros &amp; Cons</h2>
460460
<hr />
461461
<ul>
462462
<li>The codebase will be cleaner and more maintainable.</li>
463463
<li>More predictable and stricter types.</li>
464464
<li>Less maintenance overhead related to managing the baseline.</li>
465465
</ul>
466-
<h2><a id="flow-php-links-and-references" href="#content-links-and-references" class="mr-2" aria-hidden="true" title="Permalink">#</a>Links and References</h2>
466+
<h2><a id="links-and-references" href="#links-and-references" class="mr-2" aria-hidden="true" title="Permalink">#</a>Links and References</h2>
467467
<hr />
468468
<ul>
469469
<li><a rel="noopener noreferrer" target="_blank" href="https://github.com/flow-php/flow/issues/1329">#1329</a></li>

documentation/adrs/template/index.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -427,39 +427,39 @@ <h1 class="hidden lg:block">
427427
</a>
428428
</div>
429429

430-
<h1><a id="flow-php-decision-title" href="#content-decision-title" class="mr-2" aria-hidden="true" title="Permalink">#</a>[Decision Title]</h1>
430+
<h1><a id="decision-title" href="#decision-title" class="mr-2" aria-hidden="true" title="Permalink">#</a>[Decision Title]</h1>
431431
<p>Proposed by: @author_github_username
432432
Date: YYYY-MM-DD</p>
433-
<h2><a id="flow-php-context" href="#content-context" class="mr-2" aria-hidden="true" title="Permalink">#</a>Context</h2>
433+
<h2><a id="context" href="#context" class="mr-2" aria-hidden="true" title="Permalink">#</a>Context</h2>
434434
<hr />
435435
<p><code>// Todo: Describe context here</code></p>
436436
<blockquote>
437437
<p>What is the current situation or issue that needs addressing?<br />
438438
Why is this decision necessary?<br />
439439
Any relevant background or constraints.</p>
440440
</blockquote>
441-
<h2><a id="flow-php-decision" href="#content-decision" class="mr-2" aria-hidden="true" title="Permalink">#</a>Decision</h2>
441+
<h2><a id="decision" href="#decision" class="mr-2" aria-hidden="true" title="Permalink">#</a>Decision</h2>
442442
<hr />
443443
<p><code>// Todo: Describe the decision here</code></p>
444444
<blockquote>
445445
<p>What is the decision being made?<br />
446446
State it clearly and concisely.</p>
447447
</blockquote>
448-
<h2><a id="flow-php-pros--cons" href="#content-pros--cons" class="mr-2" aria-hidden="true" title="Permalink">#</a>Pros &amp; Cons</h2>
448+
<h2><a id="pros--cons" href="#pros--cons" class="mr-2" aria-hidden="true" title="Permalink">#</a>Pros &amp; Cons</h2>
449449
<hr />
450450
<p><code>// Todo: Describe the consequences here</code></p>
451451
<blockquote>
452452
<p>What are the outcomes or implications of this decision?<br />
453453
Highlight both positive and negative impacts.</p>
454454
</blockquote>
455-
<h2><a id="flow-php-alternatives-considered-optional" href="#content-alternatives-considered-optional" class="mr-2" aria-hidden="true" title="Permalink">#</a>Alternatives Considered (optional)</h2>
455+
<h2><a id="alternatives-considered-optional" href="#alternatives-considered-optional" class="mr-2" aria-hidden="true" title="Permalink">#</a>Alternatives Considered (optional)</h2>
456456
<hr />
457457
<p><code>// Todo: Describe the alternatives here</code></p>
458458
<blockquote>
459459
<p>Briefly describe any alternatives that were considered.<br />
460460
Why were they not chosen?</p>
461461
</blockquote>
462-
<h2><a id="flow-php-links-and-references-optional" href="#content-links-and-references-optional" class="mr-2" aria-hidden="true" title="Permalink">#</a>Links and References (optional)</h2>
462+
<h2><a id="links-and-references-optional" href="#links-and-references-optional" class="mr-2" aria-hidden="true" title="Permalink">#</a>Links and References (optional)</h2>
463463
<hr />
464464
<blockquote>
465465
<p>Include any supporting documents, links to issues, pull requests, or discussions that provide context.</p>

documentation/components/adapters/avro/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -427,7 +427,7 @@ <h1 class="hidden lg:block">
427427
</a>
428428
</div>
429429

430-
<h1><a id="flow-php-avro-adapter" href="#content-avro-adapter" class="mr-2" aria-hidden="true" title="Permalink">#</a>Avro Adapter</h1>
430+
<h1><a id="avro-adapter" href="#avro-adapter" class="mr-2" aria-hidden="true" title="Permalink">#</a>Avro Adapter</h1>
431431
<ul>
432432
<li><a href="/documentation/introduction">⬅️️ Back</a></li>
433433
</ul>

0 commit comments

Comments
 (0)