Skip to content

Z/doctrine docs - #136

Open
zanbaldwin wants to merge 2 commits into
6.xfrom
z/doctrine-docs
Open

zanbaldwin wants to merge 2 commits into
6.xfrom
z/doctrine-docs

Conversation

@zanbaldwin

Copy link
Copy Markdown
Member

No description provided.

@greptile-apps

greptile-apps Bot commented Sep 16, 2026

Copy link
Copy Markdown

Greptile Summary

The Doctrine documentation adds compatibility and query-parameter binding guidance. One non-blocking documentation issue remains: the raw-binary binding example does not work for every supported DBAL release and should be qualified before publication.

Confidence Score: 4/5

This change is safe to merge, but the documentation should be corrected to avoid giving supported DBAL 2.3 users a class-not-found error.

The review identified one verified, non-blocking documentation compatibility problem and no higher-impact or security issues.

Files Needing Attention: docs/08-doctrine.md:94 needs DBAL-version-specific raw binary binding guidance.

T-Rex T-Rex Logs

What T-Rex did

  • T-Rex produced proof for a posted P2 finding and attached a shell script artifact and a log artifact.
  • T-Rex executed the DBAL-23 binary-binding validation script and captured the validation output.
  • T-Rex produced a second proof for a posted P2 finding.

View all artifacts

T-Rex Ran code and verified through T-Rex

Comments Outside Diff (1)
  1. General comment

    P2 DBAL 2.3 documentation recommends a class that does not exist

    • Bug
      • Line 94 unconditionally tells readers to pass Doctrine\DBAL\ParameterType::BINARY. In Doctrine DBAL 2.3.0, that class and constant are absent, so this causes a class-not-found failure for supported DBAL 2.3 users. The DBAL-2-compatible third argument for raw binary/LOB binding is \PDO::PARAM_LOB.
    • Cause
      • The documentation uses the newer ParameterType API while declaring support that includes DBAL ^2.3.
    • Fix
      • Qualify the recommendation by DBAL version, or use \PDO::PARAM_LOB for the DBAL-2-compatible example.

    T-Rex Ran code and verified through T-Rex

Reviews (1): Last reviewed commit: "docs(doctrine): 📚 state the DBAL versio..." | Re-trigger Greptile

Comment thread docs/08-doctrine.md Outdated
the Symfony configuration shown above). The type accepts an IP object or a
protocol string, converts it to the stored binary form, and binds it as binary
on every database platform. If you must bind raw bytes yourself, pass
`Doctrine\DBAL\ParameterType::BINARY` as the third argument instead.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Support DBAL 2.3 binding

The page declares support for DBAL ^2.3, but this example tells every reader to use Doctrine\DBAL\ParameterType::BINARY. That class does not exist in DBAL 2.3, so supported users following the raw-byte example receive a class-not-found error. Qualify this by DBAL version and show \PDO::PARAM_LOB as the DBAL 2-compatible binding type. This is a non-blocking documentation concern, but correcting it prevents users of a supported dependency version from receiving a runtime error.

Artifacts

Evidence from the check

  • Downloads the exact upstream Doctrine DBAL 2.3.0 source tag and checks for ParameterType and the binary binding implementation, ending with the DBAL 2.3 compatibility check.

Command output from the check

  • Captured execution from `/home/user/repo` shows no ParameterType or BINARY declaration in DBAL 2.3.0 and shows BlobType returning PDO::PARAM_LOB, establishing the correct DBAL-2-compatible binding argument.

View artifacts

T-Rex Ran code and verified through T-Rex

…QL parameters

An untyped parameter is bound as a string, so the object is cast to protocol notation and silently matches nothing (#87, #91).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant