README

Core contracts and value objects for Polysource. Pure PHP 8.1+. Zero Symfony dependency.

The contract layer the rest of Polysource builds on — and the contract layer your extensions implement. 26 public types total. Coverage gate ≥ 90% (currently 99.17%).

The contracts

Tiny on purpose. If a contract grows past 5 methods we open an ADR (cf. ADR-010).

Value objects

All final with readonly properties. Mutations return new instances via with*() methods. Named exception: FieldTrait is a fluent mutable builder — never share a single field instance between two resources.

• DataQuery — filters + sort + pagination + search text
• DataPage — list<DataRecord> + optional total (null = unknown / cursor-based)
• DataRecord — opaque id + payload
• DataPayload — write-time payload
• FilterCriterion — (property, operator, values)
• Pagination — (offset, limit)
• SortDirection — enum
• ActionResult — (outcome, message, data) — success / failure / exception
• AdminContext — request-scoped admin state
• 17 more — see src/.

Install

composer require polysource/core

Requires PHP 8.1+ (cf. ADR-015).

Why "zero Symfony dependency"

You can use polysource/core in any PHP framework — Laravel, Slim, vanilla, anywhere. The Symfony wiring lives in polysource/symfony-bundle. The contracts here travel.

This is the line we won't cross: any PR adding a Symfony dependency to this package gets rejected on principle. See ADR-007 — PHP / Symfony version baseline.

Documentation

• Architectural choices (ADRs)
• Extension points — every contract here, with sample code
• Architecture cible — full signatures + request flow

License

MIT