包简介

The library for generating information about project's classes

README 文档

README

uml-php is a library for crawling and generating data structors from project's classes. Information about classes based on doc comments and signature of classes, methods, properties and etc. Information about classes is represented by a number of nodes:

Install

composer require ok/uml-php --dev

Usage

Simple way to use it is create a some cli command

<?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();

run this using terminal and write output in file

$ php test.php >> file

The result file will contains a data about project's classes, serialized to JSON. You can write and use your own serializer if needed. If you will use default serializer you can interpret data via simple uml-viewer. But it is ugly right now.

If you want to get data as is array of php nodes, just use getRaw method in your code

$uml->getRaw();

ok/uml-php 适用场景与选型建议

ok/uml-php 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 47 次下载、GitHub Stars 达 0，最近一次更新时间为 2019 年 04 月 27 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「php」「data」「reflection」「graph」「uml」「diagram」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 ok/uml-php 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 ok/uml-php 我们能提供哪些服务？

定制开发 / 二次开发

基于 ok/uml-php 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发