Building an HTTP Client Wrapper with Timeouts

When working with PHP, you may need to wrap remote HTTP requests with connection and overall timeouts. This guide explains the operation, shows what its arguments mean, and uses three separate examples to make the result easier to understand.

Building an HTTP Client Wrapper with Timeouts: This topic combines several operations. The code demonstrates the important sequence and its effect.

What Is Building an HTTP Client Wrapper with Timeouts in PHP?

Wrap remote HTTP requests with connection and overall timeouts. This topic combines several operations. The code demonstrates the important sequence and its effect.

Syntax:

See the complete PHP example below.

Parameters and return value: The signature above identifies the arguments and return type where the API has a single call. For topic guides, follow the sequence of calls in the examples. Always distinguish a returned value from an object or variable modified by reference.

Important: Timeouts bound waiting time but do not prevent SSRF. For user-provided URLs, enforce trusted hosts and redirect rules.

Example 1: Basic Usage

This example introduces the operation with a short and predictable input.

<?php

$options = ["http" => ["method" => "GET", "timeout" => 5]];
$context = stream_context_create($options);
var_dump(is_resource($context));

Output:

bool(true)

The code focuses on the main operation. This topic combines several operations. The code demonstrates the important sequence and its effect.

Example 2: Another Case

Now compare a different input, locale, date, or option to see another part of the behavior.

<?php

$clientSettings = ["connect_timeout" => 2, "total_timeout" => 6];
if ($clientSettings["total_timeout"] <= $clientSettings["connect_timeout"]) {
    throw new InvalidArgumentException("Timeouts must be ordered");
}
print_r($clientSettings);

Output:

Array
(
    [connect_timeout] => 2
    [total_timeout] => 6
)

What changes? Timeouts bound waiting time but do not prevent SSRF. For user-provided URLs, enforce trusted hosts and redirect rules.

Practical Example: Applying It in an Application

Use the following separate example as a starting point for a small application task. Check any extension or environment requirements below before running it.

<?php

function requestJson(string $url, int $timeoutSeconds = 5): array {
    $handle = curl_init($url);
    curl_setopt_array($handle, [CURLOPT_RETURNTRANSFER => true, CURLOPT_CONNECTTIMEOUT => 2, CURLOPT_TIMEOUT => $timeoutSeconds, CURLOPT_FOLLOWLOCATION => false]);
    $response = curl_exec($handle);
    if ($response === false) {
        throw new RuntimeException(curl_error($handle));
    }
    $statusCode = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
    if ($statusCode < 200 || $statusCode >= 300) {
        throw new RuntimeException("HTTP status: " . $statusCode);
    }
    return json_decode($response, true, 512, JSON_THROW_ON_ERROR);
}

The practical example demonstrates how to apply this operation to multiple values, a reusable task, or a validated input. This topic combines several operations. The code demonstrates the important sequence and its effect.

Important Behavior and Edge Cases

• Core behavior: This topic combines several operations. The code demonstrates the important sequence and its effect.
• Inputs and results: Timeouts bound waiting time but do not prevent SSRF. For user-provided URLs, enforce trusted hosts and redirect rules.
• Alternatives: cURL gives granular request controls, while stream contexts cover simpler requests.
• Compatibility: The practical example requires the cURL extension and defines a reusable function without making a network request.

Comparison With Related Functions

Common Beginner Mistakes

Key Takeaways

• Building an HTTP Client Wrapper with Timeouts helps you wrap remote HTTP requests with connection and overall timeouts.
• This topic combines several operations. The code demonstrates the important sequence and its effect.
• Timeouts bound waiting time but do not prevent SSRF. For user-provided URLs, enforce trusted hosts and redirect rules.

Use Building an HTTP Client Wrapper with Timeouts when you need to wrap remote HTTP requests with connection and overall timeouts. Start with the first example, compare the second, and adapt the practical example to your inputs. Confirm the return value and environment requirements before adding it to production code.