README

The kernel contracts of the CoolMS platform. Entity vocabulary, persistence-neutral mapping attributes, domain events, and the seams every module implements.

Four dependencies, all Symfony components. No ORM, no framework, no bundle.

use CoolMS\Core\Identifier\IdentifierProviderTrait;
use CoolMS\Core\Mapping\Column;
use CoolMS\Core\Model\AggregateRootInterface;

class OutboxRecord implements AggregateRootInterface
{
    use IdentifierProviderTrait;

    public function __construct(
        #[Column(type: 'string')]
        public string $type,
    ) {}
}

That entity is mapped by whichever persistence adapter is installed. It names none of them.

Installation

composer require coolms/core

On its own this package gives you contracts and value objects. To persist anything you also need an adapter — see Persistence.

What is in here

Area	What it holds
`Mapping/`	`Column`, `Id`, `GeneratedValue` — persistence-neutral attributes
`Identifier/`, `Timestampable/`, `Blameable/`	the reusable entity traits and their contracts
`Attribute/`	`ClassMeta`, `FieldMeta` — how a class describes itself to the platform
`Event/`, `Lifecycle/`	domain events, recorded-event providers, entity lifecycle events
`Outbox/`, `Inbox/`, `ChangeFeed/`	the transactional outbox, consumer idempotency, and sync change-feed rows plus their ports
`Config/`, `Secret/`, `Option/`	configuration loading, the secret-store contract, option sources
`Backup/`, `Retention/`	the backup contributor seam and the retention pruner port

Persistence

The mapping attributes are declarations; something has to read them. A persistence adapter package provides coolms/core-persistence-implementation and does the reading:

composer require coolms/core-doctrine

The attribute vocabulary is deliberately small — the columns the traits actually use, and nothing else. It is a translation, not a second mapping layer: the moment it grows associations or inheritance, there are two schemas to keep in step instead of one.

Related packages

Package	Role
`coolms/core-module`	application services composed over these contracts
`coolms/core-bundle`	Symfony integration
`coolms/core-doctrine`	Doctrine ORM/DBAL adapter

License

MIT. See LICENSE.

coolms / core

Maintainers

Package info

Statistics

Security