Request

Table of content

• Request
• Table of content
• About
• Requirements
• Available HTTP verbs
  • Get
  • Post
  • Post without payload
  • Post with payload
  • Put
  • Put without payload
  • Put with payload
  • Patch
  • Patch without payload
  • Patch with payload
  • Delete
  • Delete without payload
  • Delete with payload
  • Options
  • Head
• Batch requests
  • Executing batch requests
• Troubleshooting

About

This class is responsible for executing HTTP requests using cURL with support for custom headers. Responses are encapsulated in the Response class, providing properties like statusCode, headers, and body for better usability.

Requirements

This requires lib curl to be active with your PHP settings. You can install it via:

# For Debian/Ubuntu  
sudo apt-get install php-curl  

# For CentOS/RHEL  
sudo yum install php-curl  

Minimum requirements:

• PHP >= 7.4
• lib curl >= 7.29.0

For more information, see the PHP cURL documentation.

Available HTTP verbs

Get

Performs HTTP GET requests with custom headers.

$headers = array("User-Agent: test/1.0", "Accept: application/json");

$request = new Request();
$response = $request->get("https://example.com/", $headers);

if ($response->statusCode >= 200 && $response->statusCode < 300) {
    echo $response->body;
}

Post

Post without payload

Performs HTTP POST requests with custom headers.

$headers = array("User-Agent: test/1.0", "Accept: application/json");

$request = new Request();
$response = $request->post("https://example.com/", $headers);

if ($response->statusCode >= 200 && $response->statusCode < 300) {
    echo $response->body;
}

Post with payload

Performs HTTP POST requests with custom headers and a payload.

$headers = array("User-Agent: test/1.0", "Accept: application/json");
$payload = array("some" => "thing");

$request = new Request();
$response = $request->post("https://example.com/", $headers, json_encode($payload));

if ($response->statusCode >= 200 && $response->statusCode < 300) {
    echo $response->body;
}

Put

Put without payload

Performs HTTP PUT requests with custom headers.

$headers = array("User-Agent: test/1.0", "Accept: application/json");

$request = new Request();
$response = $request->put("https://example.com/", $headers);

if ($response->statusCode >= 200 && $response->statusCode < 300) {
    echo $response->body;
}

Put with payload

Performs HTTP PUT requests with custom headers and a payload.

$headers = array("User-Agent: test/1.0", "Accept: application/json");
$payload = array("some" => "thing");

$request = new Request();
$response = $request->put("https://example.com/", $headers, json_encode($payload));

if ($response->statusCode >= 200 && $response->statusCode < 300) {
    echo $response->body;
}

Patch

Patch without payload

Performs HTTP PATCH requests with custom headers.

$headers = array("User-Agent: test/1.0", "Accept: application/json");

$request = new Request();
$response = $request->patch("https://example.com/", $headers);

if ($response->statusCode >= 200 && $response->statusCode < 300) {
    echo $response->body;
}

Patch with payload

Performs HTTP PATCH requests with custom headers and a payload.

$headers = array("User-Agent: test/1.0", "Accept: application/json");
$payload = array("some" => "thing");

$request = new Request();
$response = $request->patch("https://example.com/", $headers, json_encode($payload));

if ($response->statusCode >= 200 && $response->statusCode < 300) {
    echo $response->body;
}

Delete

Delete without payload

Performs HTTP DELETE requests with custom headers.

$headers = array("User-Agent: test/1.0", "Accept: application/json");

$request = new Request();
$response = $request->delete("https://example.com/", $headers);

if ($response->statusCode >= 200 && $response->statusCode < 300) {
    echo $response->statusCode;
}

Delete with payload

Performs HTTP DELETE requests with custom headers and a payload.

$headers = array("User-Agent: test/1.0", "Accept: application/json");
$payload = array("some" => "thing");

$request = new Request();
$response = $request->delete("https://example.com/", $headers, json_encode($payload));

if ($response->statusCode >= 200 && $response->statusCode < 300) {
    echo $response->statusCode;
}

Options

Performs HTTP OPTIONS requests with custom headers.

$headers = array("User-Agent: test/1.0", "Accept: application/json");

$request = new Request();
$response = $request->options("https://example.com/", $headers);

if ($response->statusCode >= 200 && $response->statusCode < 300) {
    foreach ($response->headers as $header) {
      echo $header;
    }
}

Head

Performs HTTP HEAD requests with custom headers.

$headers = array("User-Agent: test/1.0", "Accept: application/json");

$request = new Request();
$response = $request->head("https://example.com/", $headers);

if ($response->statusCode >= 200 && $response->statusCode < 300) {
    foreach ($response->headers as $header) {
      echo $header;
    }
}

Batch requests

Executing batch requests

The executeBatch method allows for the execution of multiple HTTP requests in parallel using curl_multi_init. This method processes requests concurrently, reducing the total execution time for large batches.

Example usage

$batchRequests = [
    [
        'method' => 'GET',
        'url' => 'https://example.com/api1',
        'headers' => ["Accept: application/json"]
    ],
    [
        'method' => 'POST',
        'url' => 'https://example.com/api2',
        'headers' => ["Content-Type: application/json"],
        'payload' => json_encode(['key' => 'value'])
    ]
];

$request = new Request();
$responses = $request->executeBatch($batchRequests);

foreach ($responses as $key => $response) {
    if ($response->getStatusCode() >= 200 && $response->getStatusCode() < 300) {
        echo "Response $key: " . $response->getBody();
    } else {
        echo "Error in request $key: " . $response->getMessage();
    }
}

Parameters for batch requests

Each batch request requires the following structure:

• method (required): The HTTP method to use (e.g., GET, POST, PUT, PATCH, DELETE).
• url (required): The full URL for the request.
• headers (optional): An array of HTTP headers.
• payload (optional): The request body, applicable for POST, PUT, PATCH, and DELETE methods.

Notes

1. Concurrency Limit: The executeBatch method processes up to 10 requests concurrently (as defined by MAX_CONCURRENT_REQUESTS in the Request.php file).
2. Error Handling: If a request fails, its corresponding Response object will contain error details (e.g., statusCode: -1 and an error message in getMessage()).
3. Response Object: Each response is wrapped in the Response class, providing structured access to the statusCode, body, and headers.

Troubleshooting

If the request could not be completed for some reason, the result status code will be -1, and an error property will be set with the content of the curl_error response.

$request = new Request();
$response = $request->get("https://invalid-domain");

if ($response->statusCode === -1) {
  echo $response->error; // This is only populated when the status code equals to -1.
}