Driver: Improve section about PHP

[amotl]

About

• What the title says.
• Add information about AMPHP and PDO_PGSQL.
• Reorganize section. Each client gets a dedicated page.

Preview

https://cratedb-guide--404.org.readthedocs.build/connect/php/

/cc @matriv, @seut

[coderabbitai]

Walkthrough

Replaces the single legacy PHP docs page with a PHP sub-index and four driver-specific pages (AMPHP, PDO_PGSQL, Crate PDO wrapper, Crate DBAL); updates driver listing and example badge anchors to point to the new PHP subpage/anchor and removes the old docs/connect/php.md.

Changes

Cohort / File(s)	Summary of Changes
Removed — legacy PHP guide docs/connect/php.md	Deleted the original PHP page that contained PDO and DBAL examples and introductory text.
Updated — drivers listing & anchors docs/connect/drivers.md, docs/connect/index.md	Updated PHP driver link targets to the new PHP subpage and changed example badge anchors from #php to #connect-php.
Added — PHP sub-index & driver pages docs/connect/php/index.md, docs/connect/php/amphp.md, docs/connect/php/pdo-pgsql.md, docs/connect/php/crate-pdo.md, docs/connect/php/crate-dbal.md	Added a new PHP index and four driver-specific pages (AMPHP PostgreSQL, PDO_PGSQL, CrateDB PDO wrapper, CrateDB DBAL) including CI badges, synopses, PHP code examples, and cross-links.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant Dev as Developer (reads docs)
  participant Docs as Documentation site
  participant AMPHP as Amp\Postgres (async example)
  participant PDOpg as PDO_PGSQL (sync example)
  participant PDOC as Crate\PDO\PDOCrateDB (sync example)
  participant DB as CrateDB

  rect rgb(245,250,255)
    note right of Dev: New PHP sub-index exposes driver-specific flows
  end

  Dev->>Docs: open PHP sub-index
  Docs-->>Dev: links to AMPHP, PDO_PGSQL, Crate PDO, Crate DBAL

  par AMPHP (async)
    Dev->>AMPHP: follow example (create pool, prepare, execute)
    AMPHP->>DB: async query
    DB-->>AMPHP: rows / error
    AMP HP-->>Dev: await results (doc example)
  and PDO_PGSQL (sync)
    Dev->>PDOpg: follow example (new PDO, query, fetch)
    PDOpg->>DB: query
    DB-->>PDOpg: rows / error
    PDOpg-->>Dev: fetch results
  and Crate PDO wrapper (sync)
    Dev->>PDOC: follow example (PDOCrateDB, query, fetch)
    PDOC->>DB: query
    DB-->>PDOC: rows / error
    PDOC-->>Dev: fetch results
  end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Potential focus areas:

• Verify removed content in docs/connect/php.md is intentionally deleted and not referenced elsewhere.
• Confirm updated anchors in docs/connect/drivers.md and docs/connect/index.md match the new front-matter anchor connect-php.
• Validate examples and external links in the new docs/connect/php/*.md pages for correctness and consistency.

Possibly related PRs

• Connect: Reorganize and clean up section #361 — Modifies the same connect index and drivers pages; related navigation/structure changes.
• Drivers: Fix broken links. Improve wording. #338 — Also updates driver link targets and anchors in docs/connect/*.
• Connect: Migrate pages from crate-clients-tools, to be retired soon #221 — Previously added/changed PHP driver content that this change reorganizes or replaces.

Suggested reviewers

• seut
• matriv

Poem

A rabbit hops through docs at night,
Old pages gone, new guides alight.
PDOs and AMP leap into view,
CrateDB speaks PHP anew —
Hooray, the docs now bloom and bright. 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly describes the main change: improving and reorganizing the PHP driver documentation section with new content and dedicated pages.
Description check	✅ Passed	The description is directly related to the changeset, outlining the reorganization, addition of AMPHP and PDO_PGSQL information, and restructuring into dedicated pages.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch php

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5e3ba99 and 4274d39.

📒 Files selected for processing (1)

• docs/connect/php/amphp.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/connect/php/amphp.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build docs

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}