README

A Puppeteer bridge for PHP, supporting the entire API. Based on Rialto, a package to manage Node resources from PHP.

以下是一些示例 借用自 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 >= 7.3 和 Node >= 8。

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

composer require nesk/puphpeteer
npm install @nesk/puphpeteer

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 = 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 的新实例。

为了避免这种情况，您可以要求 Node 通过在指令前添加 ->tryCatch 来捕获这些错误

use Nesk\Rialto\Exceptions\Node;

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

相反，将抛出 Node\Exception，Node 进程将保持活动状态并可用于操作。

Puppeteer 插件

要使用 puppeteer-extra 插件，请将其添加到您的项目中

npm install puppeteer puppeteer-extra puppeteer-extra-plugin-stealth

然后使用 js_extra 选项覆盖 js 包含

    $puppeteer = new Puppeteer([
        'js_extra' => /** @lang JavaScript */ "
            const puppeteer = require('puppeteer-extra');
            const StealthPlugin = require('puppeteer-extra-plugin-stealth');
            puppeteer.use(StealthPlugin());
            instruction.setDefaultResource(puppeteer);
        "
    ]);

许可证

MIT 许可证（MIT）。有关更多信息，请参阅 许可证文件。

Logo 属性

PuPHPeteer 的标志由以下组成

• Puppet by Luis Prado from the Noun Project.
• 大象 由Lluisa Iborra提供，来自名词项目。

感谢Laravel新闻为我们的标志选择图标和颜色。