PHP Luminova: Network Class for Managing HTTP Outgoing Requests

The Network class is a utility designed to simplify HTTP requests to external resources, such as APIs, web services, and websites. It simplifies the process of sending requests and efficiently handling responses, allowing you to read entire content or use the File Input Stream to read large contents in parts.

Key Features

• Independence: The Network class operates independently, using cURL for making network requests, which allows for basic functionality without additional dependencies.
• Complex Requests: For more advanced use cases, the class integrates the Guzzle HTTP Client library, enabling developers to utilize advanced features and a wide range of customization options.

Whether performing simple GET and POST requests or engaging in more complex interactions, the Network class offers robust capabilities to meet your needs.

Class Definition

• Class namespace: \Luminova\Http\Network
• This class implements: \Luminova\Interface\NetworkInterface, \Luminova\Interface\LazyInterface

Usage Examples

cURL Client Options: Find the detailed description below.

[
    'verify'            => false,
    'max'               => 5,
    'connect_timeout'   => 0,
    'allow_redirects'   => true,
    'stream'            => false, 
    'sink'              => 'php://temp', // with read and write mode
    'file_time'         => false,
    'version'           => CURL_HTTP_VERSION_NONE,
    'decode_content'    => '',
    'referer'           => false,
    'output_headers'    => false,
    'headers'           => [ ... ],
    'proxy'             => [ ... ],
    'cookies'           => Luminova\Interface\CookieJarInterface|string,
    'on_headers'        => function (Luminova\Http\Message\Response $response, array $header) { ... },

    // The bellow options cannot be used together
    'query'             => [ ... ],
    'body'              => [ ... ],
    'form_params'       => [ ... ],
    'multipart'         => [ ... ]
];

Class Initialization

You can initialize the Network class with either the cURL or Guzzle client. The client initialization options are immutable and cannot be overridden after initialization.

Using cURL Client

<?php
use Luminova\Http\Client\Curl;

$client = new Curl([
    'base_uri' => 'https://example.com/'
]);

Using Guzzle Client

Installation

To use the Network class with Guzzle client, ensure you have the required packages installed.Install it via Composer:

composer require guzzlehttp/guzzle

Guzzle Client Options

When using Guzzle client all guzzle HTTP methods will be made available throw the Network class, for more detailed about Guzzle client and available options, refer to the Guzzle documentation.

<?php
use Luminova\Http\Client\Guzzle;

$client = new Guzzle([
    'base_uri' => 'https://example.com/'
]);

Making Requests

You can make HTTP requests using the get, post, and other methods provided by the cURL or Guzzle client class.

Note: If you did not specify a base URI, you can pass the full URL directly in the request method.

use Luminova\Https\Network;

$network = new Network($client);

// Full URL request
$response = $network->get('https://example.com/foo');

// Base URI request
$response = $network->get('foo');

Sending a GET Request

In this example, a GET request is sent using the default cURL client provided by the Network class.The response is then processed to retrieve the status code and content. Any exceptions are caught and handled appropriately.

Note: If you didn't specify stream option set to true, you can directly get the contents by simply calling getContents from the response object instead of $response->getBody()->getContents() . This is only available using cURL client

<?php
$response = $network->get('foo');

if ($response->getStatusCode() === 200) {
    echo $response->getContents();
}

Optionally without using stream, you can still open a new stream and read and write the content to stream.

<?php
$response = $network->get('foo');

if ($response->getStatusCode() === 200) {
    echo $response->getBody()->getContents();
}

Using Stream To Read Content In Parts

<?php 
$response = $network->get('foo', [
    'stream' => true
]);

$body = $response->getBody();

while (!$body->eof()) {
    echo $body->read(1024);
}

Sending a POST Request

$response = $network->post('foo', [
    'form_params' => [
        'foo' => 'bar'
    ]
]);

if ($response->getStatusCode() === 201) {
    echo 'Data submitted successfully!';
}

On Header Received Callback

You can handle large responses with callbacks:

$response = $network->get('large-file', [
    'on_headers' => function (Response $response, array $header) {
        if ($response->getHeaderLine('Content-Length') > 1024) {
            throw new \Exception('The file is too big!');
        }
    }
]);

Methods

constructor

Initializes the Network class with an optional client NetworkClientInterface object.If client is NULL, it uses cURL client for making HTTP requests.

public __construct(\Luminova\Interface\NetworkClientInterface|null $client = null): mixed

Parameters:

getClient

Retrieves the current HTTP client instance.If using cURL, it will return cURL which implements NetworkClientInterface interface otherwise it will return PSR ClientInterface.

public getClient(): NetworkClientInterface<\T>|ClientInterface<\T>

Return Value:

\Luminova\Interface\NetworkClientInterface<\T>|\Psr\Http\Client\ClientInterface<\T> - Return the instance of the HTTP client used for requests.

send

Sends an HTTP request with the specified method, URL, data, and headers.

public send(string $method, string $url, array $options = []): ResponseInterface|Response

Parameters:

Return Value:

\Psr\Http\Message\ResponseInterface|\Luminova\Http\Message\Response - Return the response returned by the server.

Throws:

• \Luminova\Exceptions\Http\RequestException - Throws if an error occurs while making the request.
• \Luminova\Exceptions\Http\ConnectException - Throws if a connection to the server cannot be established.
• \Luminova\Exceptions\Http\ClientException - Throws if the client encounters an error (4xx HTTP status codes).
• \Luminova\Exceptions\Http\ServerException - Throws if the server encounters an error (5xx HTTP status codes).

get

Executes a GET request to the specified URL with optional data and headers.

public get(string $url, array $options = []): ResponseInterface|Response

Parameters:

Return Value:

\Psr\Http\Message\ResponseInterface|\Luminova\Http\Message\Response - Return the server's response to the GET request.

Throws:

• \Luminova\Exceptions\Http\RequestException - Throws if an error occurs while making the request.
• \Luminova\Exceptions\Http\ConnectException - Throws if a connection to the server cannot be established.
• \Luminova\Exceptions\Http\ClientException - Throws if the client encounters an error (4xx HTTP status codes).
• \Luminova\Exceptions\Http\ServerException - Throws if the server encounters an error (5xx HTTP status codes).

fetch

Fetches data from the specified URL using a GET request.

public fetch(string $url, array $options = []): ResponseInterface|Response

Parameters:

Return Value:

\Psr\Http\Message\ResponseInterface|\Luminova\Http\Message\Response - Return the server's response containing the fetched data.

Throws:

• \Luminova\Exceptions\Http\RequestException - Throws if an error occurs while making the request.
• \Luminova\Exceptions\Http\ConnectException - Throws if a connection to the server cannot be established.
• \Luminova\Exceptions\Http\ClientException - Throws if the client encounters an error (4xx HTTP status codes).
• \Luminova\Exceptions\Http\ServerException - Throws if the server encounters an error (5xx HTTP status codes).

post

Executes a POST request to the specified URL with the provided data and headers.

public post(string $url, array $options = []): ResponseInterface|Response

Parameters:

Return Value:

\Psr\Http\Message\ResponseInterface|\Luminova\Http\Message\Response - Return the server's response to the POST request.

Throws:

• \Luminova\Exceptions\Http\RequestException - Throws if an error occurs while making the request.
• \Luminova\Exceptions\Http\ConnectException - Throws if a connection to the server cannot be established.
• \Luminova\Exceptions\Http\ClientException - Throws if the client encounters an error (4xx HTTP status codes).
• \Luminova\Exceptions\Http\ServerException - Throws if the server encounters an error (5xx HTTP status codes).

request

Performs an HTTP request with the specified method, URL, data, and headers.

public request(string $method, string $url, array $options = []): ResponseInterface|Response

Parameters:

Return Value:

\Psr\Http\Message\ResponseInterface|\Luminova\Http\Message\Response - Return the response returned by the server.

Throws:

• \Luminova\Exceptions\Http\RequestException - Throws if an error occurs while making the request.
• \Luminova\Exceptions\Http\ConnectException - Throws if a connection to the server cannot be established.
• \Luminova\Exceptions\Http\ClientException - Throws if the client encounters an error (4xx HTTP status codes).
• \Luminova\Exceptions\Http\ServerException - Throws if the server encounters an error (5xx HTTP status codes).

Configuration Options

The following options are available for the Luminova cURL client, most of the option name are same in Guzzle client as well, to see full guzzle option read the documentation by following the link in this documentation.

verify (string|bool)

• Description: Determines whether to verify the peer's SSL certificate.
• Default: false
• When to Use: Set this to true to ensure secure connections, false if you're working with self-signed certificates or string to specify the certificate path /path/to/cert.pem.

max (int)

• Description: Specifies the maximum number of redirects to follow.
• Default: 5
• When to Use: Adjust this value if you anticipate needing to follow more redirects. For example, set a higher value for APIs that might redirect multiple times.

output_headers (bool)

• Description: Specify weather to output header with the content body same as setting CURLOPT_HEADER.
• Default: false
• When to Use: Use this when you want to output or write both the header and body.

connect_timeout (int)

• Description: Sets the maximum time in seconds to wait for a connection to be established.
• Default: 0 (no timeout)
• When to Use: Use this to prevent long hangs when attempting to connect to a server. Set a reasonable timeout value (e.g., 10 seconds) to handle connection issues gracefully.

allow_redirects (bool)

• Description: Indicates whether to automatically follow HTTP redirects.
• Default: true
• When to Use: Keep this as true for most scenarios, especially when working with URLs that may redirect. Set to false if you want to handle redirects manually.

stream (bool)

• Description: Specifies whether to return the response as a stream instead of a string.
• Default: false
• When to Use: Set this to true if you expect large responses and want to process them as they arrive, rather than loading the entire response into memory at once.

sink (path-string|resource)

• Description: The path or resource to write the response body to.
• Default: php://temp (temporary memory storage)
• When to Use: Specify a file path if you want to save the response directly to a file, particularly useful for downloading large files.

file_time (bool)

• Description: Determines whether to retrieve the file modification time.
• Default: false
• When to Use: Set this to true if you need to check the last modified time of the file being downloaded.

version (string)

• Description: Specifies the HTTP version to use for the request.
• Default: CURL_HTTP_VERSION_NONE
• When to Use: Use this option if you need to enforce a specific HTTP version (e.g., CURL_HTTP_VERSION_2_0) for compatibility with server requirements.

decode_content (string)

• Description: Controls how to decode the response body.
• Default: Blank string (no specific decoding)
• When to Use: Specify encoding types (e.g., gzip, deflate) if you expect the server to return compressed content.

referer (bool)

• Description: Indicates whether to send the Referer header with the request.
• Default: false
• When to Use: Set this to true if you need to pass along the referring URL for analytics or tracking purposes.

query (array)

• Description: Query parameters for GET requests.
• When to Use: Use this to append parameters to the URL for GET requests, which can be useful for filtering or searching resources.

'query' => [                    
    'Foo' => 'Bar'
],

body (array)

• Description: The request body for POST, PUT, and PATCH requests.
• When to Use: Use this when you need to send data in the body of a request, such as JSON payloads.

'body' => [            
    'foo' => 'bar'
],

form_params (array)

• Description: Parameters for form submissions in POST, PUT, and PATCH requests.
• When to Use: Use this for sending application/x-www-form-urlencoded data, typical for form submissions.

'form_params' => [              
    'foo' => 'bar'
],

multipart (array)

• Description: Contains multipart form data for uploading files and data.
• When to Use: Use this option when you need to upload files or large data as multipart/form-data.

'multipart' => [             
    [
        'name'     => 'foo',
        'contents' => 'some data..',
    ],
    [
        'name'     => 'bar',
        'contents' => '/path/to/file/image.png' // If using path it must be readable
    ],
    [
        'name'     => 'baz',
        'contents' => new \CurlFile('/path/to/file/image.png'),
        'filename' => 'avatar.png'
    ]
],

headers (array)

• Description: Sets custom headers for the request.
• When to Use: Use this to add or override headers, such as authentication tokens or content types.

'headers' => [                  
    'Foo' => 'Bar'
],

on_headers (callable)

• Description: A callback function that is called when headers are received.
• When to Use: Use this to perform custom logic based on response headers, such as checking content length or handling specific status codes.

'on_headers' => function (Luminova\Http\Message\Response $response, array $header) { 
    // Custom logic when header is received
},

proxy (array|string)

• Description: Configures a proxy for cURL requests. It can be specified as a string for a single proxy URL or an array for detailed proxy settings. The array format allows separate proxies for http and https, optional authentication credentials, and domains to bypass the proxy.

• Usage:

  • String Format: Directly specifies a single proxy URL.
  • Array Format: Provides more custom control with support for:
  • http: Proxy for HTTP requests.
  • https: Proxy for HTTPS requests.
  • username: Optional username for proxy authentication.
  • password: Optional password for proxy authentication.
  • no: List of domains to bypass the proxy.

• Examples:

  String Format

  Copy

  'proxy' => 'http://localhost:8125'

  Array Format

  Copy

  'proxy' => [
    'http' => '1.1.1.1:8080',
    'https' => '1.1.1.1:8081',
    'username' => 'foo',
    'password' => 'bar',
    'no' => ['.foo.ng', 'example.com']
  ]

cookies (Luminova\Interface\CookieJarInterface|string)

• Description: This allows you integrate with cURL Network request client class when making request that require cookies for session management or tracking.For more information see the documentation.

• Examples:

  String Format

  Copy

  'cookies' => 'path/to/writeable/tempt/cookies.txt'

  Instance of Cookie File Jar

  Copy

  'cookies' => new Luminova\Cookies\CookieFileJar(
  'path/to/writeable/tempt/cookies.txt',
  [...]
  )