ok/

uml-php

用于生成项目类信息的库

1.2 2022-08-30 12:26 UTC

This package is auto-updated.

Last update: 2024-08-29 05:36:29 UTC


README

uml-php是一个用于从项目的类中爬取和生成数据结构的库。基于文档注释和类、方法、属性等的签名,类信息由多个节点表示。

安装

composer require ok/uml-php --dev

使用方法

使用它的简单方法是在CLI命令中创建一个命令

<?php

namespace Tests;

use OK\Uml\Uml;
use OK\Uml\Parser\Parser;
use OK\Uml\Serializer\JsonSerializer;

class Test {
    public function __construct() {
        require_once __DIR__ . '/vendor/autoload.php';
        $uml = new Uml('path_to_project', new Parser(), new JsonSerializer());
        
        echo $uml->get();
    }
}

$test = new Test();

在终端中运行此命令并将输出写入文件

$ php test.php >> file

结果file将包含有关项目类的数据,序列化为JSON。如果需要,您可以编写并使用自己的序列化器。如果您使用默认序列化器,可以通过简单的uml-viewer来解释数据。但现在它看起来很丑。

如果您想以PHP节点数组的形式获取数据,只需在您的代码中使用getRaw方法。

$uml->getRaw();