masfernandez/value-object

@todo

0.2.1 2022-10-01 16:20 UTC

Requires

• php: >=8.1
• lambdish/phunctional: ^2.1
• longitude-one/doctrine-spatial: ^3.0
• ramsey/uuid: ^4.2
• symfony/uid: ^5.3|^6.1
• symfony/validator: ^5.3|^6.1

Requires (Dev)

• php-coveralls/php-coveralls: ^2.5
• phpstan/phpstan: ^1.8
• phpunit/phpunit: ^9.5
• rector/rector: ^0.14.5
• roave/security-advisories: dev-latest
• squizlabs/php_codesniffer: *
• vimeo/psalm: ^4.27

MIT

• Miguel Ángel Sánchez Fernández

README

value-object

Collection of ValueObject ready to use on DDD projects with Symfony validator integrated



Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
   • Examples
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgements

About The Project

I have created this collection of ValueObjects to use in the projects I am working on.

ValueObjects types

• String
• Nullable string
• Uuid
• Nullable uuid
• Mixed
• Int
• Nullable int
• Float
• Nullable float
• DateTime Y-m-d\TH:i:sP
• DateTime milliseconds Y-m-d\TH:i:s.uP
• Coordinate (x float, y float)

Getting Started

Prerequisites

N/A

Installation

composer require masfernandez/value-object

Examples

Value object modeling a book title. It enforces a string primitive type, not blank by default on StringValueObject.

<?php

declare(strict_types=1);

namespace My\Awesome\Ddd\Project;

use Masfernandez\ValueObject\StringValueObject;

final class BookTitle extends StringValueObject
{
}

$bookTitle = new BookTitle('Implementing Domain-Driven Design');
echo $bookTitle->value();
echo $bookTitle;

# output

$ Implementing Domain-Driven Design
$ Implementing Domain-Driven Design

Wrong book title: can not be blank

$bookTitle = new BookTitle('');

'This value is too short. It should have 1 character or more.'

Value object modeling a user email. It enforces a string primitive type, not blank by default on StringValueObject, and add some additional constraints: email format and a max length of 255

<?php

declare(strict_types=1);

namespace My\Awesome\Ddd\Project;

use Masfernandez\ValueObject\StringValueObject;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\Constraints;

final class UserEmail extends StringValueObject
{
    /**
     * @return Constraint[]
     */
    protected static function setConstraints(): array
    {
        return array_merge(
            parent::setConstraints(),
            [
                new Constraints\Email(),
                new Constraints\Length(['max' => 255]),
            ]
        );
    }
}

$userEmail = new UserEmail('[e-mail]');
echo $userEmail->value();
echo $userEmail;

# output

$ [e-mail]
$ [e-mail]

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Miguel Ángel Sánchez Fernández - [e-mail]

(linkedin hiden profile - require login)

Project Link: https://github.com/masfernandez/value-object

Acknowledgements

• README template based on: https://github.com/othneildrew/Best-README-Template
• CHANGELOG template based on: https://keepachangelog.com/en/1.0.0/

Stats