InlineStyle 项目技术文档

1. 安装指南

使用 Composer 安装

InlineStyle 项目可以通过 Composer 进行安装。请按照以下步骤操作：

1. 打开终端或命令行工具。

2. 运行以下命令来安装 InlineStyle：

   composer.phar require inlinestyle/inlinestyle
   

   或者，您也可以手动将以下内容添加到您的 composer.json 文件中：

   "require": {
       "inlinestyle/inlinestyle": "1.*"
   }
   

3. 运行 composer install 或 composer update 来安装依赖。

2. 项目的使用说明

导入 InlineStyle

在使用 InlineStyle 之前，您需要导入该类：

use \InlineStyle\InlineStyle;

创建 InlineStyle 对象

您可以通过以下两种方式创建 InlineStyle 对象：

1. 从 HTML 文件创建：

   $htmldoc = new InlineStyle("testfiles/test.html");
   

2. 从 HTML 字符串创建：

   $htmldoc = new InlineStyle(file_get_contents("http://github.com"));
   

应用嵌入和外部样式表

首先，您需要从文档中提取样式表，然后应用它们：

$htmldoc->applyStylesheet($htmldoc->extractStylesheets());

如果您需要指定外部样式表的基 URL，可以使用以下方式：

$htmldoc->applyStylesheet($htmldoc->extractStylesheets(null, "http://github.com"));

应用额外的样式表

您还可以应用自定义的 CSS 模板到每个处理的 HTML 文件：

$htmldoc->applyStylesheet(file_get_contents("testfiles/external.css"));

获取修改后的 HTML

在多次调用 applyStylesheet 后，您可以通过以下方式获取修改后的 HTML 字符串：

$html = $htmldoc->getHTML();

3. 项目 API 使用文档

InlineStyle::__construct

• 描述: 创建一个新的 InlineStyle 对象。
• 参数:
  • $html (string): HTML 字符串或 HTML 文件路径。
• 返回值: 无。

InlineStyle::extractStylesheets

• 描述: 从文档中提取样式表。
• 参数:
  • $baseURL (string, 可选): 外部样式表的基 URL。
• 返回值: 提取的样式表内容。

InlineStyle::applyStylesheet

• 描述: 应用样式表到 HTML 文档。
• 参数:
  • $stylesheet (string): 要应用的样式表内容。
• 返回值: 无。

InlineStyle::getHTML

• 描述: 获取修改后的 HTML 字符串。
• 参数: 无。
• 返回值: 修改后的 HTML 字符串。

4. 项目安装方式

InlineStyle 项目通过 Composer 进行安装。请参考 安装指南 部分获取详细的安装步骤。