Establishes the contract layer the rest of v0.2.0 builds on. Pre-1.0
SemVer break: ModelPublisher::publishEntityChange() now takes BridgeOp
instead of a raw string.
Interfaces (Symfony idiom: same namespace as concrete, like HubInterface
next to Hub):
- PublisherInterface — publish(string, array, bool)
- ModelPublisherInterface — publishEntityChange(object, BridgeOp)
- CorrelationContextInterface — set/get/clear
App code should typehint these instead of the concretes so swappable
implementations (offline-buffer publisher, multi-hub fan-out, request-
stamp correlation) remain non-breaking. Concrete classes implement them
unchanged; autowire continues to inject the implementations transparently.
BridgeOp: PHP 8.1 string-backed enum with cases Upsert / Delete /
Replace / Event matching PLAN.md §4's envelope `op` wire format.
Internal call sites updated; tests use the cases directly.
Switched typehints:
- ModelPublisher ctor: PublisherInterface + CorrelationContextInterface
- DoctrineBridgeListener ctor: ModelPublisherInterface
- HealthController ctor: PublisherInterface (still emits `Publisher`
as bundle canary value — `::class` resolves to the concrete class
name regardless of typehint, so bundled-supervisor.sh's grep stays
green)
- skeleton PingController ctor: PublisherInterface (canonical app
pattern — example/todo has no Publisher consumer to update)
Drive-by: removed deprecated setAccessible(true) call in
ModelPublisher::extractId — PHP 8.1+ allows reflection without it.
PHPStan + cs-fixer + PHPUnit (17/17) + maker snapshot all pass; dev
container compiles in the example app.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
24 lines
713 B
PHP
24 lines
713 B
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace PhpQml\Bridge;
|
|
|
|
/**
|
|
* Translates a Doctrine entity lifecycle event into the bridge's Mercure
|
|
* envelopes (collection topic + entity topic) per PLAN.md §6.
|
|
*
|
|
* The public API surface of `ModelPublisher`. App code that wants to
|
|
* republish a model change manually (rare — the Doctrine listener covers
|
|
* the common case) should typehint this interface.
|
|
*/
|
|
interface ModelPublisherInterface
|
|
{
|
|
/**
|
|
* Publish an `upsert` / `delete` / `replace` envelope for the given
|
|
* `#[BridgeResource]` entity. Entities not tagged with the attribute
|
|
* are silently ignored.
|
|
*/
|
|
public function publishEntityChange(object $entity, BridgeOp $op): void;
|
|
}
|