Contract
Contract is a Domain-owned port for a stable capability or outbound dependency.
Generated facts
- Layer
- domain
- Generated path
app/Pulsar/Domain/{Domain}/Contracts/{Name}.php- Generator command
make:contract- Workflow method
- None
- Stability
- Current manifest surface (Pulsar 0.4.1)
Canonical example
Generated src/stubs/contract.stub — canonical synchronized stub.
<?php
namespace {{namespace}};
interface {{name}}
{
// Define the capability this port exposes.
// Accept/return DTOs, Value Objects, Enums, or scalars — never framework response objects.
}
Responsibility
Contract owns the responsibility stated above; it must not absorb delivery, transaction, or unrelated cross-layer behavior.
Placement and dependencies
Keep this type in its generated Domain path. Domain is independent of delivery concerns; Infrastructure implements Domain-owned Contracts at its boundary.
Workflow and tests
Contract is consumed by the owning Domain or Service workflow and returns a delivery-neutral result. Test its direct contract, its rejected boundary cases, and the caller or callee that proves the rule in application flow.
Three pitfalls
- ❌ Prohibited: move this responsibility into a neighboring type merely because it is nearby.
- ✅ Correct: keep the generated placement and depend only on the documented layer direction.
- ✅ Correct: test the boundary through the caller and the return or side effect visible to its callee.
Related reading
Read architecture placement for shared rationale and follow this page’s related concept links for the adjacent responsibility.
Boundaries
❌ Prohibited: Do not import a concrete Infrastructure implementation into a Contract example.
✅ Correct: Name the capability without a suffix and bind its adapter outside Domain.