chisphefo/puphpeteer

PHP的Puppeteer桥接器,支持全部API。

v2.0.1 2022-07-20 16:18 UTC

This package is auto-updated.

Last update: 2024-09-28 07:40:06 UTC


README

PHP Version Composer Version Node Version NPM Version Build Status

PHP的Puppeteer桥接器,支持全部API。基于Rialto,一个从PHP管理Node资源的包。

以下是一些例子,从Puppeteer的文档借用并适配PHP语法

例子 - 导航到https://example.com并保存截图为example.png

use Nesk\Puphpeteer\Puppeteer;

$puppeteer = new Puppeteer;
$browser = $puppeteer->launch();

$page = $browser->newPage();
$page->goto('https://example.com');
$page->screenshot(['path' => 'example.png']);

$browser->close();

例子 - 在页面上下文中执行脚本

use Nesk\Puphpeteer\Puppeteer;
use Nesk\Rialto\Data\JsFunction;

$puppeteer = new Puppeteer;

$browser = $puppeteer->launch();
$page = $browser->newPage();
$page->goto('https://example.com');

// Get the "viewport" of the page, as reported by the page.
$dimensions = $page->evaluate(JsFunction::createWithBody("
    return {
        width: document.documentElement.clientWidth,
        height: document.documentElement.clientHeight,
        deviceScaleFactor: window.devicePixelRatio
    };
"));

printf('Dimensions: %s', print_r($dimensions, true));

$browser->close();

要求和安装

此包需要PHP >= 8.1和Node >= 8。

使用以下两个命令行进行安装

composer require chisphefo/puphpeteer
npm install @nesk/puphpeteer
npm i puppeteer

PuPHPeteer和Puppeteer之间的显著差异

Puppeteer的类必须实例化

而不是要求Puppeteer

const puppeteer = require('puppeteer');

您必须实例化Puppeteer

$puppeteer = new Puppeteer;

这将创建一个由PHP控制的新的Node进程。

您还可以向构造函数传递一些选项,请参阅Rialto的文档。PuPHPeteer也扩展了这些选项

[
    // Logs the output of Browser's console methods (console.log, console.debug, etc...) to the PHP logger
    'log_browser_console' => false,
]
⏱ 想要在Puppeteer的API中使用超过30秒的某些超时?

如果您使用超过30秒的超时,您必须为read_timeout选项设置更高的值(默认:35

$puppeteer = new Puppeteer([
    'read_timeout' => 65, // In seconds
]);

$puppeteer->launch()->newPage()->goto($url, [
    'timeout' => 60000, // In milliseconds
]);

不需要使用await关键字

在PuPHPeteer中,每个方法调用或属性获取/设置都是同步的。

一些方法已经被别名替换

以下方法已经被别名替换,因为PHP不支持方法名中的$字符

  • $ => querySelector
  • $$ => querySelectorAll
  • $x => querySelectorXPath
  • $eval => querySelectorEval
  • $$eval => querySelectorAllEval

就像使用原始方法一样使用这些别名

$divs = $page->querySelectorAll('div');

必须使用JsFunction创建评估函数

在页面上下文中评估的函数必须使用JsFunction编写,这些函数的正文必须使用JavaScript而不是PHP编写。

use Nesk\Rialto\Data\JsFunction;

$pageFunction = JsFunction::createWithParameters(['element'])
    ->body("return element.textContent");

必须使用->tryCatch捕获异常

如果在Node中发生错误,将抛出Node\FatalException并关闭进程,您必须创建一个新的Puppeteer实例。

为了避免这种情况,您可以在指令前添加->tryCatch

use Nesk\Rialto\Exceptions\Node;

try {
    $page->tryCatch->goto('invalid_url');
} catch (Node\Exception $exception) {
    // Handle the exception...
}

相反,将抛出Node\Exception,Node进程将保持活跃并可使用。

许可证

MIT许可证(MIT)。请参阅许可证文件以获取更多信息。

徽标归属

PuPHPeteer的徽标由以下内容组成

感谢 Laravel News 为选择标志的图标和颜色。