jeroen-g/ontology

Explain your domain with PHP Attributes

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

This package is auto-updated.

Last update: 2024-06-14 23:11:09 UTC


README

Ontology

Latest Version on Packagist

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

Installation

Via Composer

$ composer require jeroen-g/ontology

Usage

image

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:
  • 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

License

MIT. Please see the license file for more information.