Render ExpressionInterface check expressions and default the name by simon-mundy · Pull Request #184 · php-db/phpdb

simon-mundy · 2026-09-07T10:37:41Z

Q	A
Documentation	yes
Bugfix	yes
BC Break	no
New Feature	no
RFC	no
QA	yes
House Keeping	no

Check now takes string|ExpressionInterface $expression, ?string $name = null. An ExpressionInterface expression merges its own getExpressionData() into the check — spec CHECK (<inner spec>), values appended — so identifiers and values inside it are quoted by the platform instead of being flattened into a Literal and failing with a TypeError. Renders CHECK (a > '1') and CHECK ("a" > "b"). A plain string stays a Literal; it is an expression slot by design and the docs now say so.

An empty string throws Sql\Exception\InvalidArgumentException at construction, the same exception Expression::setExpression() throws, rather than rendering a bare CONSTRAINT header with no CHECK clause. $name defaults to null in line with PrimaryKey and UniqueKey.

Values are always inlined: DDL extends AbstractSql, not AbstractPreparableSql, and MySQL rejects a parameter marker inside a CHECK anyway (3815).

CheckTest covers the merged expression data, quoted values and identifiers via getSqlString(), % inside an Expression with and without a name, an unnamed check, the column-level inline form ("age" INTEGER NOT NULL CONSTRAINT "chk_age" CHECK (age >= 0)), and the empty-string exception.

Fixes #177

Check documented its expression as string|ExpressionInterface but always wrapped it in a Literal, so an Expression was accepted at construction and threw a TypeError at render. An empty string rendered a bare CONSTRAINT header with no CHECK clause, and the name argument had no default. An ExpressionInterface expression now contributes its own specification and values to the check, so its identifiers and values are quoted by the platform. A plain string stays a literal SQL fragment by design. An empty string throws InvalidArgumentException at construction, matching Expression::setExpression(), and the name defaults to null like PrimaryKey and UniqueKey. Fixes php-db#177 Signed-off-by: Simon Mundy <simon.mundy@peptolab.com>

codecov · 2026-09-07T10:39:38Z

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

CI installs the newest Mago, and 1.47.5 changed how the analyzer handles nested array shapes: prepareDataHierarchy() re-binds a reference into the MetadataData shape on every loop iteration, which no longer completes in useful time. Re-type the reference as a plain array so the shape is not re-derived per iteration, and adjust the expected findings accordingly. Regenerate the analyzer baseline for the reworded findings in Select, PredicateSet, Profiler and AbstractSql (the issues are unchanged, the messages are not), and reduce the continuation indent of two multi-line conditions in AbstractTableGateway to match the 1.47.4+ formatter. Signed-off-by: Simon Mundy <simon.mundy@peptolab.com>

tyrsson

Approved post conflict resolution

@throws

All 55 throw sites in src/Sql now call a named constructor. Message text is byte-identical, verified template by template against the original literals. - Add Sql\Predicate\Exception with its own ExceptionInterface, InvalidArgumentException and RuntimeException, holding the 10 templates the predicate classes use, so the messages sit with the classes that raise them rather than concentrating on one component catalogue - Add 24 templates and factories to Sql\Exception\InvalidArgumentException and 6 to Sql\Exception\RuntimeException, the last four covering the Ddl column and check constraint messages added by php-db#183, php-db#184 and php-db#185 - Collapse nine duplicated messages onto one template each, five of which the audit on php-db#189 had missed: the four "intended to work with only the table" copies in Sql, the two parameter-count copies in AbstractSql, the two column key copies in Insert, the two read-only copies in Select, and the subject messages shared by Platform and AbstractPlatform - Fix a copy-paste bug in Platform::getSqlString(), which reported prepareStatement() as the method with no effect - Retype Between's \LogicException and AbstractSql's \ValueError to the package types, so both reach the marker interface - Declare the @throws Predicate::unnest() and Predicate::__get() never had - Cover every factory with a template test, and derive the 46 Sql message assertions from the templates rather than restating them - Re-attribute the two baselined sprintf argument-type entries to the factories that now receive those arguments, and baseline the three halstead readings the refactor shifts - Exclude src/Sql/Exception/ from too-many-methods in mago.toml. The threshold is 10 and a catalogue holds one template per condition a component can report, so the count tracks failure modes rather than anything a split would improve Signed-off-by: Simon Mundy <simon.mundy@peptolab.com>

@throws

All 55 throw sites in src/Sql now call a named constructor. Message text is byte-identical, verified template by template against the original literals. - Add Sql\Predicate\Exception with its own ExceptionInterface, InvalidArgumentException and RuntimeException, holding the 10 templates the predicate classes use, so the messages sit with the classes that raise them rather than concentrating on one component catalogue, and register both concrete classes in ExceptionHierarchyTest's EXCEPTION_CLASSES map - Add 24 templates and factories to Sql\Exception\InvalidArgumentException and 6 to Sql\Exception\RuntimeException, the last four covering the Ddl column and check constraint messages added by php-db#183, php-db#184 and php-db#185 - Collapse nine duplicated messages onto one template each, five of which the audit on php-db#189 had missed: the four "intended to work with only the table" copies in Sql, the two parameter-count copies in AbstractSql, the two column key copies in Insert, the two read-only copies in Select, and the subject messages shared by Platform and AbstractPlatform - Fix a copy-paste bug in Platform::getSqlString(), which reported prepareStatement() as the method with no effect - Retype Between's \LogicException and AbstractSql's \ValueError to the package types, so both reach the marker interface - Declare the @throws Predicate::unnest() and Predicate::__get() never had - Cover every factory with a template test, and derive the 46 Sql message assertions from the templates rather than restating them - Re-attribute the two baselined sprintf argument-type entries to the factories that now receive those arguments, and baseline the three halstead readings the refactor shifts - Exclude src/Sql/Exception/ from too-many-methods in mago.toml. The threshold is 10 and a catalogue holds one template per condition a component can report, so the count tracks failure modes rather than anything a split would improve Signed-off-by: Simon Mundy <simon.mundy@peptolab.com>

@throws

All 55 throw sites in src/Sql now call a named constructor. Message text is byte-identical, verified template by template against the original literals. - Add Sql\Predicate\Exception with an InvalidArgumentException and a RuntimeException holding the 10 templates the predicate classes use, so the messages sit with the classes that raise them rather than concentrating on one component catalogue, and register both in ExceptionHierarchyTest's EXCEPTION_CLASSES map. The namespace deliberately has no ExceptionInterface of its own: both classes extend their Sql\Exception counterparts, so they are already caught by Sql\Exception\ExceptionInterface, and a narrower marker would only collapse the same InvalidArgument and Runtime split a second time - Add 24 templates and factories to Sql\Exception\InvalidArgumentException and 6 to Sql\Exception\RuntimeException, the last four covering the Ddl column and check constraint messages added by php-db#183, php-db#184 and php-db#185 - Collapse nine duplicated messages onto one template each, five of which the audit on php-db#189 had missed: the four "intended to work with only the table" copies in Sql, the two parameter-count copies in AbstractSql, the two column key copies in Insert, the two read-only copies in Select, and the subject messages shared by Platform and AbstractPlatform - Fix a copy-paste bug in Platform::getSqlString(), which reported prepareStatement() as the method with no effect - Retype Between's \LogicException and AbstractSql's \ValueError to the package types, so both reach the marker interface - Declare the @throws Predicate::unnest() and Predicate::__get() never had - Cover every factory with a template test, and derive the 46 Sql message assertions from the templates rather than restating them - Re-attribute the two baselined sprintf argument-type entries to the factories that now receive those arguments, and baseline the three halstead readings the refactor shifts - Exclude src/Sql/Exception/ from too-many-methods in mago.toml. The threshold is 10 and a catalogue holds one template per condition a component can report, so the count tracks failure modes rather than anything a split would improve Signed-off-by: Simon Mundy <simon.mundy@peptolab.com>

@throws

All 55 throw sites in src/Sql now call a named constructor. Message text is byte-identical, verified template by template against the original literals. - Add Sql\Predicate\Exception with an InvalidArgumentException and a RuntimeException holding the 10 templates the predicate classes use, so the messages sit with the classes that raise them rather than concentrating on one component catalogue, and register both in ExceptionHierarchyTest's EXCEPTION_CLASSES map. Neither namespace declares an ExceptionInterface: the package has one marker, PhpDb\Exception\ExceptionInterface, and every class here implements it by inheritance - Add 24 templates and factories to Sql\Exception\InvalidArgumentException and 6 to Sql\Exception\RuntimeException, the last four covering the Ddl column and check constraint messages added by php-db#183, php-db#184 and php-db#185 - Collapse nine duplicated messages onto one template each, five of which the audit on php-db#189 had missed: the four "intended to work with only the table" copies in Sql, the two parameter-count copies in AbstractSql, the two column key copies in Insert, the two read-only copies in Select, and the subject messages shared by Platform and AbstractPlatform - Fix a copy-paste bug in Platform::getSqlString(), which reported prepareStatement() as the method with no effect - Retype Between's \LogicException and AbstractSql's \ValueError to the package types, so both reach the marker interface - Declare the @throws Predicate::unnest() and Predicate::__get() never had - Cover every factory with a template test, and derive the 46 Sql message assertions from the templates rather than restating them - Re-attribute the two baselined sprintf argument-type entries to the factories that now receive those arguments, and baseline the three halstead readings the refactor shifts - Exclude src/Sql/Exception/ from too-many-methods in mago.toml. The threshold is 10 and a catalogue holds one template per condition a component can report, so the count tracks failure modes rather than anything a split would improve Signed-off-by: Simon Mundy <simon.mundy@peptolab.com>

simon-mundy self-assigned this Sep 7, 2026

simon-mundy added this to @phpdb Sep 7, 2026

github-project-automation Bot moved this to Todo in @phpdb Sep 7, 2026

simon-mundy added this to the 0.6.0 milestone Sep 7, 2026

simon-mundy added bug Something isn't working enhancement New feature or request qa Improvements in quality assurance of the project labels Sep 7, 2026

simon-mundy requested a review from tyrsson September 7, 2026 11:36

simon-mundy added the documentation Improvements or additions to documentation label Sep 7, 2026

tyrsson previously approved these changes Sep 28, 2026

View reviewed changes

Cleaned baseline again

7f94fb1

simon-mundy dismissed tyrsson’s stale review via 7f94fb1 September 28, 2026 01:43

Merge branch '0.6.x' into fix/177-check-constraint-expression

d7b10bb

simon-mundy merged commit 52c744b into php-db:0.6.x Sep 28, 2026
15 checks passed

This was referenced Sep 28, 2026

Route the Sql throw sites through named constructors #192

Merged

[RFC]: Named exception constructors and complete per-component exception namespaces #189

Closed

Navigation Menu

Repository navigation

Render ExpressionInterface check expressions and default the name - #184

Render ExpressionInterface check expressions and default the name#184
simon-mundy merged 4 commits into
php-db:0.6.xfrom
simon-mundy:fix/177-check-constraint-expression

simon-mundy commented Sep 7, 2026 •

edited

Loading

Uh oh!

codecov Bot commented Sep 7, 2026

Uh oh!

tyrsson left a comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

simon-mundy commented Sep 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Sep 7, 2026

Codecov Report

Uh oh!

tyrsson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

simon-mundy commented Sep 7, 2026 •

edited

Loading