somnambulist/entity-behaviours

This package is abandoned and no longer maintained. The author suggests using the somnambulist/domain package instead.

A set of behaviours and interfaces for use with entities

1.2.1 2017-10-18 00:07 UTC

Requires

• php: >=7
• somnambulist/value-objects: ~1.2

MIT

• Dave Redfern

• entities
• ddd
• behaviours

README

This repository has been archived. Please update to the combined package.s

Entity Behaviours

Provides some useful interfaces and traits that can be used with entities. The traits implement on basic methods, and still require e.g. publish/unpublish to be implemented.

Requirements

• PHP 7+

Installation

Install using composer, or checkout / pull the files from github.com.

• composer require somnambulist/entity-behaviours

Behaviours

Unlike the somnambulist/laravel-doctrine-behaviours package, these behaviours are intended to be used in a much more controlled and DDD based system. As such they do not implement setters and in some cases even the methods defined in the interfaces as these are core domain methods that should raise events within your system.

1. Activatable

   Adds activate()/deactivate() methods to an entity controlling if it is active or not. The entity should implement activate/deactivate methods so that Events can be raised.

2. GloballyTrackable

   A collection of other interfaces: Identifiable, Nameable, Timestampable, UniversallyIdentifiable.

3. Identifiable

   Adds an id() method that returns the primary identifier (int, string, object)

4. IdentifiableWithTimestamps

   A combination of Identifiable and Timestampable

5. Nameable

   Adds a name() method that returns the entity name component.

6. NumericallySortable

   Adds an ordinal() and update method for adding a numerical sorting index to an entity.

7. Publishable

   Adds publish()/unpublish() for controlling if an Entity is "published". Uses the DateTime value object. publish/unpublish are not implemented as they should raise events when used.

8. Stringable

   Adds __toString() and a toString() method that will use try the following methods:

   • displayAs()
   • title()
   • name()

   If none are present an empty string is returned.

9. Timestampable

   Adds createdAt()/updatedAt() methods. Not setters are not defined as the entity should update the updatedAt when it is changed through update calls and not rely on database behaviour.

10. Trackable

    A collection of other interfaces: Identifiable, Nameable, Timestampable

11. UniversallyIdentifiable

    Adds a uuid() method that returns a Uuid value object.

12. Versionable

    Adds a version() and incrementVersion() methods for defining the current entity version. incrementVersion should be hooked in appropriate update methods when the entity is modified.

Utilities

• EntityAccessor

  Helper class for accessing property methods/properties. Intended to be used in unit tests only.