FluentDOM 技术文档

1. 安装指南

1.1 通过 Composer 安装

FluentDOM 可以通过 Composer 进行安装。首先，确保你已经安装了 Composer，然后在你的项目目录下运行以下命令：

composer require fluentdom/fluentdom

1.2 手动安装

如果你不想使用 Composer，也可以手动下载 FluentDOM 的源码，并将其放置在你的项目目录中。然后，在你的 PHP 文件中引入 FluentDOM.php 文件：

require_once 'path/to/FluentDOM/FluentDOM.php';

2. 项目使用说明

FluentDOM 是一个扩展了 PHP 的 DOM、XMLReader 和 XMLWriter 的库，提供了类似 jQuery 的流畅接口，方便进行 XML 操作。以下是一些基本的使用示例。

2.1 读取 HTML 文件中的所有链接

$document = FluentDOM::load(
  $htmlFile,
  'text/html',
  [FluentDOM\Loader\Options::ALLOW_FILE => TRUE]
);
foreach ($document('//a[@href]') as $a) {
  $links[] = [
    'caption' => (string)$a,
    'href' => $a['href']
  ];
}
var_dump($links);

2.2 从数组创建一个选择框

$_ = FluentDOM::create();
$_->formatOutput = TRUE;
echo $_(
  'select',
  ['name' => 'example'],
  $_->each(
    ['One', 'Two', 'Three'],
    function($text, $index) use ($_) {
      return $_('option', ['value' => $index], $text);
    }
  )
)->document->saveHTML();

2.3 读取大型 XML 文件

$reader = new FluentDOM\XMLReader();
$reader->open('sitemap.xml');
$reader->registerNamespace('s', 'http://www.sitemaps.org/schemas/sitemap/0.9');

foreach (new FluentDOM\XMLReader\SiblingIterator($reader, 's:url') as $url) {
  /** @var FluentDOM\DOM\Element $url */
  var_dump(
    [
      'location' => $url('string(s:loc)'),
      'updated' => $url('string(s:lastmod)')
    ]
  );
}

3. 项目 API 使用文档

3.1 FluentDOM::load()

FluentDOM::load() 方法用于加载 XML 或 HTML 文档。支持多种格式，如 text/html、text/xml 等。

$document = FluentDOM::load('sample.xml');

3.2 FluentDOM::create()

FluentDOM::create() 方法用于创建一个新的 XML 文档。

$_ = FluentDOM::create();

3.3 FluentDOM::Query()

FluentDOM::Query() 方法用于查询和操作 DOM 节点。支持类似 jQuery 的选择器。

$fd = FluentDOM::Query('sample.xml')
  ->find('//h1[@id = "title"]')
  ->text('Hello World!');

3.4 FluentDOM::QueryCss()

FluentDOM::QueryCss() 方法支持 CSS 选择器，前提是安装了 CSS 选择器到 XPath 的翻译库。

$fd = FluentDOM::QueryCss('sample.xml')
  ->find('h1#title')
  ->text('Hello World!');

4. 项目安装方式

4.1 通过 Composer 安装

composer require fluentdom/fluentdom

4.2 手动安装

下载 FluentDOM 的源码，并将其放置在你的项目目录中。然后，在你的 PHP 文件中引入 FluentDOM.php 文件：

require_once 'path/to/FluentDOM/FluentDOM.php';

通过以上步骤，你可以成功安装并使用 FluentDOM 进行 XML 和 HTML 的操作。