Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rialto-php/puphpeteer
A Puppeteer bridge for PHP, supporting the entire API.
https://github.com/rialto-php/puphpeteer
automation developer-tools headless-chrome php puppeteer testing web
Last synced: 3 months ago
JSON representation
A Puppeteer bridge for PHP, supporting the entire API.
- Host: GitHub
- URL: https://github.com/rialto-php/puphpeteer
- Owner: rialto-php
- License: mit
- Archived: true
- Created: 2018-01-19T21:48:19.000Z (almost 7 years ago)
- Default Branch: dev
- Last Pushed: 2023-01-01T15:05:38.000Z (almost 2 years ago)
- Last Synced: 2024-05-19T12:25:40.150Z (7 months ago)
- Topics: automation, developer-tools, headless-chrome, php, puppeteer, testing, web
- Language: PHP
- Homepage:
- Size: 2.48 MB
- Stars: 1,340
- Watchers: 29
- Forks: 188
- Open Issues: 64
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
- awesome-chrome-devtools - PuPHPeteer - php bridge to node puppeteer (Chrome DevTools Protocol / Libraries for driving the protocol (or a layer above))
README
# 🚨 This project is not maintained anymore
As I write these lines, it's been nearly two years since the latest release of PuPHPeteer. Despite the enthusiasm around this project, I no longer have the motivation to support its development, mainly because it never really had any use to me. So its time to be honest with you, PuPHPeteer is no longer maintained.
However, here's a list of forks maintained by the community:
- [zoonru/puphpeteer](https://github.com/zoonru/puphpeteer)
- [NigelCunningham/puphpeteer](https://github.com/NigelCunningham/puphpeteer)
If you create a fork and plan to maintain it, let me know and I will link it here.
# PuPHPeteer
[](http://php.net/)
[](https://packagist.org/packages/nesk/puphpeteer)
[](https://nodejs.org/)
[](https://www.npmjs.com/package/@nesk/puphpeteer)
[](https://travis-ci.org/nesk/puphpeteer)
A [Puppeteer](https://github.com/GoogleChrome/puppeteer/) bridge for PHP, supporting the entire API. Based on [Rialto](https://github.com/nesk/rialto/), a package to manage Node resources from PHP.
Here are some examples [borrowed from Puppeteer's documentation](https://github.com/GoogleChrome/puppeteer/blob/master/README.md#usage) and adapted to PHP's syntax:
**Example** - navigating to https://example.com and saving a screenshot as *example.png*:
```php
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();
```
**Example** - evaluate a script in the context of the page:
```php
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();
```
## Requirements and installation
This package requires PHP >= 7.3 and Node >= 8.
Install it with these two command lines:
```shell
composer require nesk/puphpeteer
npm install @nesk/puphpeteer
```
## Notable differences between PuPHPeteer and Puppeteer
### Puppeteer's class must be instantiated
Instead of requiring Puppeteer:
```js
const puppeteer = require('puppeteer');
```
You have to instantiate the `Puppeteer` class:
```php
$puppeteer = new Puppeteer;
```
This will create a new Node process controlled by PHP.
You can also pass some options to the constructor, see [Rialto's documentation](https://github.com/nesk/rialto/blob/master/docs/api.md#options). PuPHPeteer also extends these options:
```php
[
// Logs the output of Browser's console methods (console.log, console.debug, etc...) to the PHP logger
'log_browser_console' => false,
]
```
⏱ Want to use some timeouts higher than 30 seconds in Puppeteer's API?
If you use some timeouts higher than 30 seconds, you will have to set a higher value for the `read_timeout` option (default: `35`):
```php
$puppeteer = new Puppeteer([
'read_timeout' => 65, // In seconds
]);
$puppeteer->launch()->newPage()->goto($url, [
'timeout' => 60000, // In milliseconds
]);
```
### No need to use the `await` keyword
With PuPHPeteer, every method call or property getting/setting is synchronous.
### Some methods have been aliased
The following methods have been aliased because PHP doesn't support the `$` character in method names:
- `$` => `querySelector`
- `$$` => `querySelectorAll`
- `$x` => `querySelectorXPath`
- `$eval` => `querySelectorEval`
- `$$eval` => `querySelectorAllEval`
Use these aliases just like you would have used the original methods:
```php
$divs = $page->querySelectorAll('div');
```
### Evaluated functions must be created with `JsFunction`
Functions evaluated in the context of the page must be written [with the `JsFunction` class](https://github.com/nesk/rialto/blob/master/docs/api.md#javascript-functions), the body of these functions must be written in JavaScript instead of PHP.
```php
use Nesk\Rialto\Data\JsFunction;
$pageFunction = JsFunction::createWithParameters(['element'])
->body("return element.textContent");
```
### Exceptions must be caught with `->tryCatch`
If an error occurs in Node, a `Node\FatalException` will be thrown and the process closed, you will have to create a new instance of `Puppeteer`.
To avoid that, you can ask Node to catch these errors by prepending your instruction with `->tryCatch`:
```php
use Nesk\Rialto\Exceptions\Node;
try {
$page->tryCatch->goto('invalid_url');
} catch (Node\Exception $exception) {
// Handle the exception...
}
```
Instead, a `Node\Exception` will be thrown, the Node process will stay alive and usable.
## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.
## Logo attribution
PuPHPeteer's logo is composed of:
- [Puppet](https://thenounproject.com/search/?q=puppet&i=52120) by Luis Prado from [the Noun Project](http://thenounproject.com/).
- [Elephant](https://thenounproject.com/search/?q=elephant&i=954119) by Lluisa Iborra from [the Noun Project](http://thenounproject.com/).
Thanks to [Laravel News](https://laravel-news.com/) for picking the icons and colors of the logo.