README

这里提供日语说明。
请参阅以下中文说明。

(ml)Silkworm，或简称Silkworm，是一个用于PHP的标记语言库，用于帮助创建HTML和XML文档。Silkworm充当一个抽象层，允许你在编程时只关注PHP，无需手动正确格式化HTML \t\t<tags>\n。

Silkworm可以从PHP文件生成格式良好的、回车、缩进的HTML或XML。该库是动态的，可以以模块化方式使用，允许你在程序中将文档创建过程分解成逻辑块。

历史

Silkworm是从头开始构建的，并使用PhpUnit进行了彻底的测试。

变更日志

安装和配置

安装

Silkworm没有依赖项，可以通过以下方式安装

1. GitHub复制并包含

• 从GitHub复制库
• 将Silkworm.php移动到您选择的目录
• 在您将使用它的文件中包含Silkworm.php

1. 通过Composer

• 将以下内容添加到您的composer要求中

{  
  "require": {  
    "nexocentric/silkworm": "dev-master"  
  }  
}  

实例化$html = new Silkworm();并继续。

测试

Silkworm的所有测试都已使用PhpUnit进行。测试包含在tests文件夹中，因此请随意运行它们以确认您的版本是否正常工作。

配置

Silkworm在使用前不需要任何配置。然而，有一些设置可以在下面展示使用。

Silkworm::setSilkwormAlias("HyperTextGenerator"); //change the name of the class

$html = new Silkworm();
$html->setIndentation("   "); //indentation is now set to 3 spaces
$html->setSelfClosingTagStyle("xml"); // < /> vs <>
$html->setBooleanDisplayStyle("maximize"); //disabled="disabled" vs disabled

用法

使用Silkworm有多种方式。

基本

$table = array(
    array("Version", "Name", "Changes"),
    array("1.00", "ao", "initial release")
);

$html = new Silkworm();
$html->html(
    $html->head(
        $html->title("A title")
    ),
    $html->body(
        $html->p("class", "main-text", "This is Silkworm version 1.00!"),
        $html->newline(),
        $html->comment("information about silkworm"),
        $html->autoTable($table, true)
    )
);

代码片段保存

您可以按照以下方式创建和保存代码片段。

设置

$html = new Silkworm();
$html["error"] = $html->div(
    $html->p(
      "YOU MADE A BOO BOO!"
    )
);

$html["falsePositive"] = $html->div(
    $html->p(
      "Sorry, about that. My bad."
    )
);

$html["truePositive"] = $html->div(
    $html->p(
      "On second thought... that can't be... ;)"
    )
);

如果您将(string)$html用作字符串，所有代码片段将按数字顺序然后按字母顺序自动连接。

输出

<div>
  <p>YOU MADE A BOO BOO!</p>
</div>
<div>
  <p>Sorry, about that. My bad.</p>
</div>
<div>
  <p>On second thought... that can't be... ;)</p>
</div>

您还可以选择要使用的代码片段。

(string)$html["falsePositive"];

如果您需要代码片段包含标题信息如<!DOCTYPE>，您可以使用以下函数将字符串包装起来。

(string)$html->stringWithDocumentHeader($html["truePositive"]);

高级

有关高级使用方法，请参阅examples文件夹。示例已设置并准备好显示。您应该能够通过浏览器访问文件并查看它们如何在其中显示。请随意尝试修改示例以测试系统。

联系

一般

您可以通过以下方式联系我

• Twitter: @nexocentric
• GitHub: nexocentric

错误

如果您在使用Silkworm时发现任何错误，我希望知道，以便我尽快修复它们。

请通过GitHub提交问题，我将联系您获取更多信息。

贡献

非常感谢您的贡献！

如果您想贡献，请

1. 在GitHub上分叉库
2. 对您认为将改进项目的任何更改
3. 为您的更改编写测试
4. 发起拉取请求
5. 我将通知你关于是否需要修改任何文档（这样你就不必在知道拉取请求是否可以被接受之前进行文档修改）。

我会仔细审查请求，以确保一切正常且可用。

[*] 我提前表示歉意，因为我可能无法接受所有的拉取请求。

反馈

我希望听到反馈，无论是好是坏。任何促进讨论的内容都受到欢迎。

致谢

我要感谢所有在开发过程中支持我并给予帮助和指导的人。

• 艾米·久保原
• 约翰·古德兰德
• 李奥·李
• 汤姆·巴罗
• 汤姆·格里芬
• 北村和良

版权

更多信息请参阅LICENSE文件。