whichbrowser/parser

PHP的用户代理嗅探库

维护者

详细信息

github.com/WhichBrowser/Parser-PHP

主页

源代码

问题

安装次数: 7,523,646

依赖项: 52

建议者: 5

安全: 0

星标: 1,796

关注者: 79

分支: 239

开放问题: 21

v2.1.8 2024-04-17 12:47 UTC

Requires

Requires (Dev)

Suggests

MIT 581d614d686bfbec3529ad60562a5213ac5d8d72

  • Niels Leenheer <niels.woop@leenheer.nl>

browseruauseragentsniffing

This package is auto-updated.

Last update: 2024-09-17 13:45:26 UTC

README

这是一个极其复杂且几乎完全无用的浏览器嗅探库。之所以无用，是因为你不应该使用浏览器嗅探。所以立刻停止，去阅读一些关于特性检测的内容。我是认真的。离开吧。你以后会感谢我的。

WhichBrowser/Parser-PHP

适用于服务器的WhichBrowser的PHP版本。完全兼容PHP 7.0或更高版本，包括PHP 8。

Build Coverage Status License Latest Stable Version

Twitter Follow

也可用

关于WhichBrowser

但为什么说是几乎完全无用而不是完全无用呢？ 好吧，总有例外。进行浏览器嗅探有合理的原因：为了提升用户体验或收集有关您网站上使用哪些浏览器的情报。我的网站是html5test.com，我想知道哪个分数属于哪个浏览器。为此，你需要一个浏览器嗅探库。

为什么它如此复杂？
因为每个人都撒谎。真的，没有一款浏览器是完全诚实的。几乎所有浏览器都声称自己是Netscape 5，几乎所有WebKit浏览器都说它们基于Gecko。即使是Internet Explorer 11现在也不再声称是IE，而是一个类似于Gecko的无名浏览器。而且情况变得更糟。这就是为什么它很复杂。

它提供了哪些信息？ 你会得到一个包含浏览器、渲染引擎、操作系统和设备信息的漂亮对象。它提供名称和版本，甚至设备制造商和型号。WhichBrowser相当坚韧。它提供了其他人没有的信息。例如

JUC (Linux; U; 2.3.6; zh-cn; GT-I8150; 480*800) UCWEB8.7.4.225/145/800  
UC Browser 8.7 on a Samsung Galaxy W running Android 2.3.6

Android从未被提及

Mozilla/5.0 (Series40; Nokia501/10.0.2; Profile/MIDP-2.1 Configuration/CLDC-1.1) Gecko/20100401 S40OviBrowser/3.0.0.0.73  
Nokia Xpress 3.0.0 on a Nokia Asha 501 running Nokia Asha Platform

尽管用户代理头信息声称是Series40设备，但我们知道它实际上运行的是Asha平台，我们还知道OviBrowser已被重命名为Nokia Xpress。

Opera/9.80 (X11; Linux zvav; U; zh) Presto/2.8.119 Version/11.10  
Opera Mini on a Nokia 5230 running Series60 5.0

用户代理头信息看起来像Linux上的Opera 11.10，但我们知道它是Opera Mini。我们甚至可以从前一个头信息中找出真实的操作系统和设备型号。

需求

WhichBrowser需要PHP 7.0或更高版本，并支持PHP 8。WhichBrowser与PSR-4自动加载标准兼容，并遵循PSR-1和PSR-2编码风格。

如何安装

您可以通过Composer（PHP的标准包管理器）安装WhichBrowser。该包名为whichbrowser/parser。

composer require whichbrowser/parser

您可以通过运行简单命令轻松更新WhichBrowser。

composer update whichbrowser/parser

您应该尽可能经常运行此命令。您甚至可以考虑为此设置cron作业。

如何使用

第一步需要Composer自动加载器

<?php

    require 'vendor/autoload.php';

第二步是创建一个新的WhichBrowser\Parser对象。该对象将包含库可以找到的所有关于浏览器的信息。对象有一个必需的参数，即浏览器发送的标头或用户代理字符串。使用标头是首选的，因为它将允许更好的检测，但如果您只有用户代理字符串，这也将有效。

例如

$result = new WhichBrowser\Parser(getallheaders());

或

$result = new WhichBrowser\Parser($_SERVER['HTTP_USER_AGENT']);

$result变量现在包含一个对象，您可以查询其信息。有多种方式可以访问这些信息。

首先，您可以调用toString()函数以获取可读性较高的标识

"You are using " . $result->toString();
// You are using Chrome 27 on OS X Mountain Lion 10.8

另一种可能性是查询对象

$result->isType('desktop');
// true

$result->isType('mobile', 'tablet', 'media', 'gaming:portable');
// false

$result->isBrowser('Maxthon', '<', '4.0.5');
// false

$result->isOs('iOS', '>=', '8');
// false

$result->isOs('OS X');
// true

$result->isEngine('Blink');
// true

您也可以直接访问这些属性

$result->browser->toString();
// Chrome 27  

$result->engine->toString();
// Blink

$result->os->toString();
// OS X Mountain Lion 10.8

或者直接访问这些属性的某些部分

$result->browser->name;
// Chrome

$result->browser->name . ' ' . $result->browser->version->toString();
// Chrome 27

$result->browser->version->value;
// 27.0.1453.110

$result->engine->name;
// Blink

最后，您还可以直接查询版本

$result->browser->version->is('>', 26);
// true

$result->os->version->is('<', '10.7.4');
// false

选项

在创建Parser对象时，通过传递一个数组作为第二个参数，可以设置额外的选项。

禁用机器人检测

在某些情况下，您可能想要禁用机器人的检测。这允许机器人故意欺骗WhichBrowser，以便您可以识别出机器人尝试模拟的用户代理。当您想使用WhichBrowser在您的网站的不同版本之间切换，并确保爬虫看到正确的网站版本时，这尤其有用。例如，模拟移动设备的机器人将看到您网站的移动版。

$result = new WhichBrowser\Parser(getallheaders(), [ 'detectBots' => false ]);

启用结果缓存

WhichBrowser支持PSR-6兼容的缓存适配器，用于在请求之间缓存结果。使用缓存如果您的网站上的每个页面都使用WhichBrowser，并且用户访问多个页面时非常有用。在第一次访问期间，将解析标题并缓存结果。在之后的访问中，将使用缓存结果，这比再次解析标题要快得多。

还有其他类型的缓存适配器可用，例如APC、Doctrine、Memcached、MongoDB、Redis等。这些适配器的配置各不相同，但一旦配置好，您只需在创建Parser对象时将其作为选项传递，或使用setCache()函数设置即可。WhichBrowser已测试与PHP Cache提供的适配器兼容。有关其他提供适配器的包的列表，请参阅Packagist。

例如，如果您想启用基于Memcached的缓存，需要安装额外的Composer包

composer require cache/memcached-adapter

并将对WhichBrowser/Parser的调用更改为以下内容

$client = new \Memcached();
$client->addServer('localhost', 11211);

$pool = new \Cache\Adapter\Memcached\MemcachedCachePool($client);

$result = new WhichBrowser\Parser(getallheaders(), [ 'cache' => $pool ]);

或

$client = new \Memcached();
$client->addServer('localhost', 11211);

$pool = new \Cache\Adapter\Memcached\MemcachedCachePool($client);

$result = new WhichBrowser\Parser();
$result->setCache($pool);
$result->analyse(getallheaders());

您还可以指定缓存结果应丢弃多少秒。默认值为900秒或15分钟。如果您认为WhichBrowser在缓存中使用的内存太多，应降低此值。您可以通过设置cacheExpires选项或将它作为setCache()函数的第二个参数传递来实现。

API参考

解析器对象

创建新的WhichBrowser\Parser对象后，它包含许多属性和函数。所有这些属性都保证存在。

属性

  • browser
    一个包含有关浏览器自身信息的对象
  • engine
    一个包含有关渲染引擎信息的对象
  • os
    一个包含有关操作系统信息的对象
  • device
    一个包含有关设备信息的对象

函数

getType()
返回device对象的type和subtype属性。如果存在子类型，则将其连接到类型并使用分号分隔，例如：mobile:smart或gaming:portable。如果子类型不适用，则仅返回类型，例如：desktop或ereader。

isType($type [,$type [,$type [,$type]]])
如果使用单个参数，该函数返回true，如果参数与device对象的type属性匹配。参数可以可选地通过将子类型连接到类型并使用分号分隔来提供子类型。它可以使用多个参数，在这种情况下，如果任一参数匹配，则函数返回true。如果没有参数匹配，则返回false。

isMobile()
如果浏览器是手机、平板、电子阅读器、相机、便携式媒体播放器、手表或便携式游戏机等移动设备，则返回 true。否则返回 false。

isBrowser($name [, $comparison, $version])
用于查询 browser 对象的 name 和 version 属性。该函数可以包含一个参数进行基于 name 的简单比较，或者包含三个参数比较 name 和 version。第一个参数始终包含浏览器的名称。第二个参数是一个可以包含 <、<=、=、=> 或 > 的字符串。第三个参数是一个整数、浮点数或包含版本的字符串。您可以使用版本号如 10、10.7 或 '10.7.4'。有关版本比较的更多信息，请参阅 Version 对象的 is() 函数。

isEngine($name [, $comparison, $version])
用于查询 engine 对象的 name 和 version 属性。此函数与 isBrowser 的工作方式完全相同。

isOs($name [, $comparison, $version])
用于查询 os 对象的 name 和 version 属性。此函数与 isBrowser 的工作方式完全相同。

isDetected()
是否真的检测到某些浏览器，或者我们是否未能检测到任何内容？

toString()
获取检测到的浏览器的人类可读表示，包括操作系统和设备信息。

浏览器对象

用于 WhichBrowser\Parser 主对象的 browser 属性的 WhichBrowser\Model\Browser 类的对象包含许多属性。如果属性在此情况下不适用，则将为 null 或未定义。

属性

  • name
    包含浏览器名称的字符串
  • alias
    包含浏览器替代名称的字符串
  • version
    包含浏览器版本信息的版本对象
  • stock
    一个布尔值，如果浏览器是操作系统的默认浏览器则为 true，否则为 false
  • channel
    包含分发渠道的字符串，例如 'Nightly' 或 'Next'。
  • mode
    可以包含浏览器操作模式的字符串，例如 'proxy'。
  • hidden
    一个布尔值，如果浏览器没有名称且是操作系统的默认浏览器，则为 true。
  • family
    包含有关此浏览器所属家族的信息的对象
  • using
    包含有关浏览器使用的哪种类型的 webview 的信息的对象

函数

isFamily($name)
此浏览器的家族是否有此名称，或者浏览器本身是否有此名称。

isUsing($name)
浏览器是否使用具有提供名称的 webview。

getName()
获取浏览器名称

getVersion()
获取浏览器版本

toString()
获取检测到的浏览器的人类可读表示

引擎对象

用于 WhichBrowser\Parser 主对象的 engine 属性的 WhichBrowser\Model\Engine 类的对象包含许多属性。如果属性在此情况下不适用，则将为 null 或未定义。

属性

  • name
    包含渲染引擎名称的字符串
  • version
    包含关于渲染引擎版本的版本对象

函数

getName()
获取渲染引擎名称

getVersion()
获取渲染引擎版本

toString()
获取检测到的渲染引擎的人类可读表示

操作系统对象

用于主WhichBrowser\Parser对象的os属性的WhichBrowser\Model\Os类对象包含多个属性。如果某个属性在此情况下不适用，则将为null或undefined。

属性

  • name
    包含操作系统名称的字符串
  • version
    包含有关操作系统版本的版本对象
  • family
    包含有关该操作系统属于哪个家族的信息的对象

函数

isFamily($name)
此操作系统的家族是否具有此名称，或者操作系统本身是否具有此名称。

getName()
获取操作系统的名称

getVersion()
获取操作系统的版本

toString()
获取检测到的操作系统的可读表示

设备对象

用于主WhichBrowser\Parser对象的device属性的WhichBrowser\Model\Device类对象包含多个属性。如果某个属性在此情况下不适用，则将为null或undefined。

属性

  • 类型
    包含浏览器类型的字符串
  • 子类型
    包含浏览器子类型的字符串
  • 已识别
    一个布尔值，如果设备已被正面识别则为true。
  • 制造商
    包含设备制造商的字符串，例如‘Apple’或‘Samsung’。
  • 型号
    包含设备型号的字符串，例如‘iPhone’或‘Galaxy S4’。

type属性可以包含以下列表中的任何值

  • 桌面
  • 移动
  • PDA
  • DECT
  • 平板电脑
  • 游戏
  • 电子阅读器
  • 媒体
  • 耳机
  • 手表
  • 仿真器
  • 电视
  • 显示器
  • 摄像头
  • 打印机
  • 广告牌
  • 白板
  • 开发板
  • 飞行
  • 家用电器
  • GPS
  • 汽车
  • POS
  • 机器人
  • 投影仪

如果type是“移动”，则subtype属性可以包含以下列表中的任何值

  • 功能
  • 智能

如果type是“游戏”，则subtype属性可以包含以下列表中的任何值

  • 控制台
  • 便携式

函数

getManufacturer()
获取制造商名称

getModel()
获取型号名称

toString()
获取检测到的设备的可读表示

家族对象

用于WhichBrowser\Model\Browser和WhichBrowser\Model\Os对象的family属性的WhichBrowser\Model\Family类对象包含多个属性。如果某个属性在此情况下不适用，则将为null或undefined。

属性

  • name
    包含家族名称的字符串
  • version
    包含有关家族版本的版本对象

函数

getName()
获取家族名称

getVersion()
获取家族版本

toString()
获取家族的可读表示

使用对象

用于WhichBrowser\Model\Browser对象的using属性的WhichBrowser\Model\Using类对象包含多个属性。如果某个属性在此情况下不适用，则将为null或undefined。

属性

  • name
    包含webview名称的字符串
  • version
    包含有关webview版本的版本对象

函数

getName()
获取webview名称

getVersion()
获取webview版本

toString()
获取webview的可读表示

版本对象

WhichBrowser\Model\Version 类的对象用于 browser、engine 和 os 对象的 version 属性，包含许多属性和函数。如果某个属性在此情况下不适用，它将是 null 或 undefined。

属性

  • 值
    包含原始版本号的字符串。
  • alias
    包含版本号别名的字符串，例如 Windows 的 '5.1' 对应 'XP'。
  • 昵称
    包含版本号昵称的字符串，例如 OS X 的 '10.14' 对应 'Mojave'。
  • 详细信息
    包含应打印的版本号数字的整数值。

函数

is($version) 或 is($comparison, $version)
使用此函数可以轻松比较两个版本。如果只指定一个参数，此函数将返回版本是否相同。您也可以指定两个参数，在这种情况下，第一个参数包含比较运算符，例如 <、<=、=、=> 或 >。第二个参数是要比较的版本。您可以使用版本号如 10、10.7 或 '10.7.4'，但请注意 10 与 10.0 不同。例如，如果我们的操作系统版本是 10.7.4。

$result->os->version->is('10.7.4');
// true

$result->os->version->is('10.7');
// true

$result->os->version->is('10');
// true

$result->os->version->is('10.0');
// false

$result->os->version->is('>', '10');
// false

$result->os->version->is('>', '10.7');
// false

$result->os->version->is('>', '10.7.3');
// true