MicrodataPHP 技术文档

1. 安装指南

1.1 环境要求

• PHP 5.3 及以上版本
• 自动加载器（例如 Composer 提供的自动加载器）

1.2 安装步骤

1. 使用 Composer 安装 MicrodataPHP：

   composer require linclark/microdataphp
   

2. 安装完成后，确保 vendor/autoload.php 文件存在，并在项目中引入该文件。

2. 项目的使用说明

2.1 基本使用

MicrodataPHP 是一个用于从 HTML 文档中提取微数据的 PHP 库。以下是一个基本的使用示例：

require 'vendor/autoload.php';

use linclark\MicrodataPHP\MicrodataPhp;

$url = 'http://example.com';
$md = new MicrodataPhp($url);
$data = $md->obj();

// 获取顶级项目的属性
print $data->items[0]->properties['name'][0];

// 获取嵌套项目的属性
print $data->items[0]->properties['hiringOrganization'][0]->properties['name'][0];

2.2 输出结果

上述代码将从指定 URL 的 HTML 文档中提取微数据，并输出顶级项目和嵌套项目的属性值。

3. 项目API使用文档

3.1 MicrodataPhp 类

• 构造函数：__construct($url)

  • 参数：
    • $url：要解析的 HTML 文档的 URL。
  • 功能：初始化 MicrodataPHP 对象。

• 方法：obj()

  • 返回值：提取的微数据对象。
  • 功能：从 HTML 文档中提取微数据并返回一个对象。

3.2 微数据对象结构

• items：包含所有提取的微数据项目。
  • properties：每个项目的属性集合。
    • name：属性名称。
    • value：属性值。

4. 项目安装方式

4.1 使用 Composer 安装

通过 Composer 安装是最推荐的方式，具体步骤如下：

1. 在项目根目录下运行以下命令：

   composer require linclark/microdataphp
   

2. 安装完成后，在项目中引入 vendor/autoload.php 文件。

4.2 手动安装

如果无法使用 Composer，可以手动下载项目源码并将其放置在项目目录中，然后手动引入相关文件。

---

通过以上文档，您应该能够顺利安装和使用 MicrodataPHP 项目，并了解其 API 的使用方法。