ericksonreyes/domain-driven-design

Domain driven design inspired classes and interfaces

Domain Driven Design Classes and Interfaces

A collection of Domain Driven Design inspired Classes and Interfaces.

Installation

composer require ericksonreyes/domain-driven-design

Usage

• Command Bus
• Event Bus
• Class Composition Validator

Value Objects

• Identifier
• Currency
• Email Address
• Money
• Full Name
• Name Title
• Person Name
• Name Suffix
• Address
• Street
• City
• State
• Country Code
• Zip Code
• File

Examples

• Domain Entity
• Domain Event
• Event Sourced Domain Entity
• File Attaching Domain Entity

Interfaces

• Command Bus
• Event Bus
• Event Handler
• Event Publisher
• Event Repository
• Exception Handler
• Identity Generator

Abstract Exceptions

• AuthenticationFailureException - Authentication/Login failed.
• PermissionDeniedException - Authorization failed. No permission to access a record or execute a command.
• RecordConflictException - Saving an existing record or overwriting a record with state that has been changed.
• DeletedRecordException - Accessing or deleting a record that has been deleted already.
• RecordNotFoundException - Accessing or deleting a record that never existed.
• MissingActionPerformerException - Commands that has no action performer for accountability.
• EmptyIdentifierException - Entity or aggregate with an empty identifier value.

Exceptions

• MissingEventReplayMethodException - Event sourced entity or aggregate does not have the required event replay method.
• DomainEventOwnershipException - Replaying an event that does not belong to the entity or aggregate.

domain-driven-design's Issues

Validate if the event being replayed actually belong to the aggregate/entity.

Create a version for PHP 7.3

Create API Documentation.

Add raisedBy to Event Interface

Currently we are depending on the data() method of the Event interface to learn who raised the event. Maybe it's time to learn about the accountability in the raisedBy() method.

Add FileAttachingEntity Trait

<?php
/**
 * Created by PhpStorm.
 * User: ericksonreyes
 * Date: 2019-09-11
 * Time: 14:55
 */

namespace EricksonReyes\DomainDrivenDesign;


trait FileAttachingEntity
{
    /**
     * @var array
     */
    private $attachments = [];


    /**
     * @return array
     */
    public function attachments(): array
    {
        return $this->attachments;
    }

    /**
     * @param string $attachmentId
     * @param string $fileName
     * @param string $fileType
     * @param string $fileSize
     * @param string $fileLocation
     * @param string $fileContent
     */
    protected function attachFile(
        string $attachmentId,
        string $fileName,
        string $fileType,
        string $fileSize,
        string $fileLocation,
        string $fileContent
    ): void
    {
        $this->attachments[$attachmentId] = [
            'id' => $attachmentId,
            'fileName' => $fileName,
            'fileType' => $fileType,
            'fileSize' => $fileSize,
            'fileLocation' => $fileLocation,
            'fileContent' => $fileContent
        ];
    }

    /**
     * @param string $attachmentId
     */
    protected function detachFile(string $attachmentId): void
    {
        if (array_key_exists($attachmentId, $this->attachments())) {
            unset($this->attachments[$attachmentId]);
        }
    }
}

Implement isEmpty() and isNotEmpty() to String Value Object

Create interfaces CanBeEmpty and CannotBeEmpty interfaces inside the Common/Attributes namespace.

interface CanBeEmpty
{
    /**
     * @return bool
     */
    public function isEmpty(): bool;
}

and

interface CannotBeEmpty
{
    /**
     * @return bool
     */
    public function isNotEmpty(): bool;
}