README

将 .puml 图表转换为图像的 PlantUml 包装器。

用法

本包提供三种方法

\Jawira\PlantUmlToImage\PlantUml::convertTo
\Jawira\PlantUmlToImage\PlantUml::setJar
\Jawira\PlantUmlToImage\PlantUml::isPlantUmlAvailable

将 .puml 图表转换为图像

从磁盘加载您的图表，然后使用 \Jawira\PlantUmlToImage\PlantUml 将图表转换为另一种格式。转换后，您可以将其保存到磁盘。

use Jawira\PlantUmlToImage\Format;
use Jawira\PlantUmlToImage\PlantUml;

// Load diagram
$puml = file_get_contents('./diagram.puml');

// Convert to png
$plantUml = new PlantUml();
$png = $plantUml->convertTo($puml, Format::PNG);

// Save diagram
file_put_contents('./diagram.png', $png);

设置 Jar 位置

指定 plantuml.jar 的位置

$plantUml->setJar('/path/to/plantuml.jar');

在以下情况下，您不需要设置 Jar 位置

您已使用 jawira/plantuml 下载 PlantUML（位置 vendor/jawira/plantuml/bin/plantuml.jar）。
如果您已使用 apt-get 安装 PlantUML（位置 /usr/share/plantuml/plantuml.jar）。
或者您已安装 plantuml 命令。

检查 PlantUml 可用性

如果找不到 jar，会抛出异常。使用此方法可以避免异常。

if ($plantUml->isPlantUmlAvailable()) {
  echo 'PlantUml is available.', PHP_EOL;
} else {
  echo 'Sorry, cannot convert diagram.', PHP_EOL;
}

如何安装

$ composer require jawira/plantuml-to-image

要求

本包需要 PlantUml（https://plantuml.com/en/download）作为可执行文件或 Jar 文件，请注意 PlantUml 有其自身的需求（https://plantuml.com/en/starting）。

作为替代，您可以使用 Composer 安装 PlantUml。

$ composer require jawira/plantuml

贡献

如果您喜欢这个项目，⭐ 在 GitHub 上给它加星标。

许可证

本库采用MIT 许可证。

jawira 的软件包

jawira/doctrine-diagram-bundle: Symfony 扩展包，用于生成数据库图表。
jawira/case-converter: 在 13 种命名约定之间转换字符串：Snake case、Camel case、Pascal case、Kebab case、Ada case、Train case、Cobol case、Macro case、Upper case、Lower case、Sentence case、Title case 和 Dot notation。
更多...

jawira / plantuml-to-image

维护者

详细信息