jeroen-g/ontology

Explain your domain with PHP Attributes

dev-main 2022-06-14 18:26 UTC

Requires

• ergebnis/classy: ^1.3
• league/flysystem: ^3.0
• nunomaduro/termwind: ^1.3
• roave/better-reflection: ^5.0
• webmozart/assert: ^1.10

Requires (Dev)

• phpunit/phpunit: ~9.0
• symplify/easy-coding-standard: ^10.0

MIT

• Jeroen

• documentation
• php
• ddd
• ontology

README

Explain and validate your domain with PHP Attributes and automatically generate documentation from it.

Installation

Via Composer

$ composer require jeroen-g/ontology

Usage

Change log

Please see the changelog for more information on what has changed recently.

Contributing

So you'd like to contribute? Awesome! Here is a (incomplete) list of things on the roadmap that you could start a PR on, but feel free to suggest anything else!

• Dockerfile
• Ahoy/Makefile
• More attributes, such as:
  • Tag
  • SideEffect, SideEffectFree
  • Highlight
  • Bankrupt
  • BoundedContext
  • Factory
  • DataTransferObject
  • Command
  • Query
• Testing helpers, such as:
  • Get all classes with given attribute
  • Get all (DDD) attributes for a given class
  • protip: https://github.com/thephpleague/construct-finder
• More validators for all attributes, based on widely agreed conventions (e.g. value objects should have no setters)
• Does this work with custom, from outside the package, DDD attributes?

Credits

• Jeroen
• All Contributors

License

MIT. Please see the license file for more information.