aktuba / puphpeteer
PHP 的 Puppeteer 桥接器,支持完整 API。
Requires
- php: >=7.1
- aktuba/rialto: ^1.3.1
- psr/log: ^1.0
- vierbergenlars/php-semver: ^3.0.2
Requires (Dev)
- codedungeon/phpunit-result-printer: >=0.6 <1.0
- monolog/monolog: ^1.23
- phpunit/phpunit: ^6.5|^7.0
- symfony/process: ^5.0
README
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 >= 7.1 和 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 的 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 的标志由以下部分组成
- Puppet,由 Luis Prado 提供,来自 The Noun Project。
- Elephant,由 Lluisa Iborra 提供,来自 The Noun Project。
感谢 Laravel News 选择标志的图标和颜色。
支持我
PuPHPeteer 是一个需要大量工作的项目(尤其是与 Rialto 相关)。虽然我很乐意在业余时间工作,但有时我也喜欢和朋友们喝几杯啤酒。如果你想支持开发,请在 BeerPay 上给我买杯啤酒。🙏