Add Enum, Mailer and Form conventions to Structure & Conventions#8287
Open
dereuromark wants to merge 1 commit into5.xfrom
Open
Add Enum, Mailer and Form conventions to Structure & Conventions#8287dereuromark wants to merge 1 commit into5.xfrom
dereuromark wants to merge 1 commit into5.xfrom
Conversation
Extend conventions.md with Enum, Mailer and Form class conventions so the page reflects current CakePHP 5.x application structure: - Add Enum class example (src/Model/Enum/ArticleStatus) with file path, PSR-4 row, reference table row, file tree entry and SQL column example - Add Form (src/Form/*Form.php) and Mailer (src/Mailer/*Mailer.php) to the src/ directory table and the PSR-4 naming table - Fix Enum docs anchor (#enum-type) and replace misleading created_at column example with is_processed (CakePHP defaults to created/modified)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Extend
docs/en/intro/conventions.mdto cover modern CakePHP 5.x application classes that were missing from the Structure & Conventions page:src/Model/Enum/) — newArticleStatuscode example, PSR-4 row, reference table row, and entry in the file tree diagram plus the SQL examplesrc/Mailer/*Mailer.php) — added to the src/ directory table and PSR-4 naming tablesrc/Form/*Form.php) — added to the src/ directory table and PSR-4 naming tableAlso:
#enum-type) to match the actual heading inorm/database-basics.mdcreated_atcolumn example withis_processed(CakePHP defaults tocreated/modified, which is what the Complete Example SQL uses)