wundii/structron

A PHP library for generating human-readable documentation from structured data objects like DTOs, Entities, and Value Objects.

1.0.2 2025-06-27 05:29 UTC

Requires

• php: >=8.2
• ext-json: *
• symfony/config: ^6.4 || ^7.0
• symfony/console: ^6.4 || ^7.0
• symfony/dependency-injection: ^6.4 || ^7.0
• symfony/finder: ^6.4 || ^7.0
• webmozart/assert: ^1.11
• wundii/data-mapper: ^1.4

Requires (Dev)

• phpstan/phpstan: ^2.0
• phpstan/phpstan-strict-rules: ^2.0
• phpunit/phpunit: ^11.5
• rector/rector: ^2.0
• symfony/var-dumper: ^7.0
• symplify/easy-coding-standard: ^12.5
• wundii/phplint: ^0.3

MIT

• Andreas Wunderwald

• documentation
• phpdoc
• php
• reflection
• markdown
• code generator
• entity
• Value Object
• dto
• doc generator
• doc tool

README

A PHP library for generating human-readable documentation from structured data objects like DTOs, Entities, and Value Objects. This is based on the data mapper.

Installation

Require the bundle and its dependencies with composer:

composer require wundii/afterbuy-sdk

Creating the config file

vendor/bin/structron init

Configuration

use Wundii\Structron\Config\StructronConfig;

return static function (StructronConfig $structronConfig): void {
    $structronConfig->docPath('your/docs/folder');
    $structronConfig->paths(['your/dto/folder', 'your/other/dto/folder']);
    
    /**
     * Optional: The input in this example is the default value 
     */
    $structronConfig->phpExtension('php');
    $structronConfig->skip([]);
    $structronConfig->setIndentFileIteration();
    
    /**
     * Other possibilities for automated use
     */
    $structronConfig->disableProcessBar();
    $structronConfig->disableExitCode();
};

Usage

vendor/bin/structron