Roach PHP Core

To use Roach in your PHP project, install the core package using Composer:

composer require roach-php/core

The pool() method allows you to execute a list of RoachPHP\Http\Request objects concurrently.

Parameters:

• array $requests: A list of Request objects to be processed.
• ?callable $onFulfilled: A callback executed when a request succeeds. It receives a RoachPHP\Http\Response object.
• ?callable $onRejected: A callback executed when a request fails. It receives a RoachPHP\Http\RequestException (or a Response object if the failure was a BadResponseException).

Behavior:

• If a request results in a BadResponseException (e.g., a 4xx or 5xx error with a response body), the client wraps the response in a RoachPHP\Http\Response object so it can be processed by middleware.
• For all other errors, it throws a RoachPHP\Http\RequestException wrapping the original Guzzle exception.

The RoachPHP\Http\Client class is the primary entrypoint for making HTTP requests during scraping. It implements ClientInterface and wraps a Guzzle client. You can instantiate it with a custom GuzzleHttp\Client instance if you need specific configuration, or let it default to a new Guzzle client.

To handle multiple requests efficiently, use the pool() method, which executes requests concurrently using a Guzzle Pool.

The roach:run command accepts the following argument:

The fetch command allows you to perform a GET request to a specified URL within the Roach shell environment. When executed, it populates the shell's scope with two new variables: $response (a RoachPHP\Http\Response object) and $html (the raw HTML string of the response). This is useful for quickly inspecting a page's structure before writing scraping logic.

Usage: fetch <url>