PHP User Agent 技术文档

1. 安装指南

使用 Composer 安装

推荐使用 Composer 来安装 php-user-agent 项目。首先，确保你已经安装了 Composer。然后，在你的项目根目录下运行以下命令：

composer require your-vendor-name/php-user-agent

安装完成后，Composer 会自动将 php-user-agent 添加到你的项目依赖中，并生成自动加载文件。

手动安装

如果你不使用 Composer，也可以手动下载项目文件并将其放置在你的项目目录中。你需要手动包含类文件：

require_once '/path/to/php-user-agent/phpUserAgent.php';
require_once '/path/to/php-user-agent/phpUserAgentStringParser.php';

2. 项目的使用说明

基本用法

php-user-agent 是一个用于检测用户浏览器信息的 PHP 库。它通过分析用户代理字符串来识别浏览器名称、版本、操作系统以及引擎信息。

以下是一个基本的使用示例：

// 创建一个用户代理对象
$userAgent = new phpUserAgent();

// 获取浏览器名称
$browserName = $userAgent->getBrowserName();  // 例如：firefox

// 获取浏览器版本
$browserVersion = $userAgent->getBrowserVersion();  // 例如：3.6

// 获取操作系统
$operatingSystem = $userAgent->getOperatingSystem();  // 例如：linux

// 获取引擎
$engine = $userAgent->getEngine();  // 例如：gecko

自定义用户代理字符串

你可以通过传递自定义的用户代理字符串来创建 phpUserAgent 对象：

// 使用自定义用户代理字符串
$userAgent = new phpUserAgent('msnbot/2.0b (+http://search.msn.com/msnbot.htm)');
$browserName = $userAgent->getBrowserName();  // 例如：msnbot

自定义解析器

你可以通过继承 phpUserAgentStringParser 类来创建自定义的解析器，并将其注入到 phpUserAgent 对象中：

// 创建自定义用户代理字符串解析器
class myUserAgentStringParser extends phpUserAgentStringParser
{
  // 重写方法
}

// 注入自定义解析器
$userAgent = new phpUserAgent(null, new myUserAgentStringParser());

3. 项目API使用文档

phpUserAgent 类

__construct($userAgentString = null, $parser = null)

• 参数:
  • $userAgentString (string): 用户代理字符串，默认为当前用户的用户代理字符串。
  • $parser (phpUserAgentStringParser): 自定义的解析器对象，默认为 phpUserAgentStringParser。

getBrowserName()

• 返回值: 返回检测到的浏览器名称。

getBrowserVersion()

• 返回值: 返回检测到的浏览器版本。

getOperatingSystem()

• 返回值: 返回检测到的操作系统。

getEngine()

• 返回值: 返回检测到的浏览器引擎。

phpUserAgentStringParser 类

parse($userAgentString)

• 参数:
  • $userAgentString (string): 用户代理字符串。
• 返回值: 返回解析后的用户代理信息。

4. 项目安装方式

使用 Composer 安装

composer require your-vendor-name/php-user-agent

手动安装

1. 下载项目文件并将其放置在你的项目目录中。
2. 手动包含类文件：

require_once '/path/to/php-user-agent/phpUserAgent.php';
require_once '/path/to/php-user-agent/phpUserAgentStringParser.php';

通过以上步骤，你就可以在你的 PHP 项目中使用 php-user-agent 来检测用户浏览器信息了。