Extension points

phil/doctrine-behaviours

The library declares no service: an application registers the listeners it wants on its entity manager — see Integration. What it implements is the interfaces its entities take on, and who is acting.

`Contract\BlameResolver`

Phil\DoctrineBehaviours\Contract\BlameResolver — who is acting now, given to BlameListener.

Method	Contract
`current(): ?string`	A stable name of the user of the request, job or command, or `null` when nobody is known — then nothing is written

FixedBlame names always the same one, or nobody: for imports, commands and tests. A resolver of the application's own names users by an identifier that is not personal information where it can, since the name is copied into every blamed row — see Timestamps and blame.

`Contract\OwnerResolver`

Phil\DoctrineBehaviours\Contract\OwnerResolver, who new records belong to, given to OwnerListener.

Method	Contract
`current(): ?OwnerId`	The stable identifier of the owner, or `null` when nobody is known; then nothing is written

FixedOwner names always the same one, or nobody. See Owner.

`Contract\VersionRestoreGuard`

Phil\DoctrineBehaviours\Contract\VersionRestoreGuard, the right to go back to a past version, given to Versions.

Method	Contract
`check(Versionable $entity, int $number): void`	Throws when the right is missing; `VersionRestoreDenied`, or an exception of the application's own

AllowVersionRestore lets everyone, RefuseVersionRestore no one. See Versions.

The sluggers

SlugListener takes the Sluggers of phil/slug: a slugger named or decorated there applies here, and Sluggable::sluggerName() picks one for an entity. See Slug.

The entity interfaces

An entity takes on a behaviour by implementing its interface, by hand or with the trait that maps its columns.

Interface	Trait	What the listener calls
`Contract\Timestampable`	`TimestampableEntity`	`stampCreated()`, `stampUpdated()`
`Contract\Blameable`	`BlameableEntity`	`blameCreated()`, `blameUpdated()`
`Contract\SoftDeletable`	`SoftDeletableEntity`	`markDeleted()`; `restore()` is the application's to call — see Soft delete
`Contract\TreeNode`	`TreeNodeEntity`	`placeInTree()` — see Trees
`Contract\Deactivatable`	`DeactivatableEntity`	`stampDeactivated()`; `deactivate()` and `reactivate()` are the application's to call — see Deactivation
`Contract\Ownable`	`OwnableEntity`	`claimOwner()`; `transferOwner()` is the application's to call — see Owner
`Contract\Publishable`	`PublishableEntity`	`markPublished()`, `markUnpublished()`; the workflow moves the state — see Publication
`Contract\Positionable`	`PositionableEntity`	`placeAt()`; `positionGroup()` names the group — see Position
`Contract\Sluggable`	`SluggableEntity`, `ScopedSluggableEntity`	`assignSlug()`; `slugScope()` names the scope — see Slug
`Contract\Translatable`	—	`newTranslation()`; `translationClass()` and `translatedFields()` name the rest — see Translation
`Contract\Translation`	`TranslationEntity`	`translatable()`, `locale()` — see Translation
`Contract\Versionable`	`VersionableEntity`	`forkVersion()`; `Versions` freezes — see Versions
`Contract\DatedIdentifiable`	`DatedIdentifierEntity`	`assignDatedId()` — see Dated identifier

An entity that implements an interface by hand keeps the columns and names of its own; the listeners read and write through the methods only.

Listeners and the filter

Point	How
The time	The PSR-20 clock given to `TimestampListener` and `SoftDeleteListener`: stamps are in UTC
Which behaviours run	Only the listeners registered: each stands alone
Seeing deleted rows	`SoftDeletedFilter`, under `SoftDeletedFilter::NAME`, disabled for the queries that need them
Seeing deactivated rows	`DeactivatedFilter`, under `DeactivatedFilter::NAME`, disabled for the queries that need them
Erasing a user's name	`BlameEraser::find()` and `replace()`, over every blamed table
Erasing an owner	`OwnerEraser::find()` and `replace()`, over every owned table
The locales served	The `FallbackChain` the application gives `Translations`, from the `DeclaredLocales` of `phil/locale-dimensions`
The publication workflow	`PublicationWorkflow`'s places and transitions, or a workflow of the application's own with those three places