Static Public Member Functions
static	checkInternetState ()
static	get ($url, $headers=array())
static	getApiJson ($url, $headers=array())
static	getCurlHeaders ($url, $headers=array())
static	getCurlHttpHeaders ($url)
static	getFopenHttpHeaders ($url)
static	getHttpHeaders ($pingUrl)
static	getVerbose ()
static	setVerbose ($verbose)

Static Private Member Functions
static	categorizeCurlError ($errorCode, $errorMessage, $isLocalhost)
static	getApiHeaders ()
static	getCABundlePath ()
static	getDefaultHeaders ()

Static Private Attributes
static	$verbose = false

Detailed Description

HttpClient class for handling HTTP requests using cURL.

Definition at line 11 of file class.httpclient.php.

Member Function Documentation

◆ categorizeCurlError()

categorizeCurlError	(	$errorCode,
		$errorMessage,
		$isLocalhost )

staticprivate

Categorizes cURL errors for better logging and debugging.

Parameters

int	$errorCode	The cURL error code.
string	$errorMessage	The cURL error message.
bool	$isLocalhost	Whether the request was made to a localhost URL.

Returns: string The error category.

Definition at line 271 of file class.httpclient.php.

    {
        // Connection errors (e.g., DNS resolution, connection refused, timeouts)
        if (in_array($errorCode, array(
            CURLE_COULDNT_RESOLVE_HOST,  // 6
            CURLE_COULDNT_CONNECT,       // 7
            CURLE_OPERATION_TIMEOUTED,   // 28
            CURLE_RECV_ERROR,           // 56
            CURLE_SEND_ERROR            // 55
        ))) {
            return 'connection';
        }
 
        // SSL/TLS certificate and verification errors
        if (in_array($errorCode, array(
            CURLE_SSL_CACERT,           // 60 - CA certificate verification failed
            CURLE_SSL_PEER_CERTIFICATE, // 60 - Peer certificate cannot be authenticated
            CURLE_SSL_CERTPROBLEM,     // 58 - Certificate problem
            CURLE_SSL_CIPHER,          // 59 - Failed to use specified cipher
            CURLE_SSL_CONNECT_ERROR,   // 35 - SSL connection error
            CURLE_SSL_ENGINE_NOTFOUND, // 53 - SSL engine not found
            CURLE_SSL_ENGINE_SETFAILED // 54 - Cannot set SSL crypto engine as default
        ))) {
            // For localhost, treat SSL errors as self-signed certificate issues
            return $isLocalhost ? 'self-signed' : 'ssl';
        }
 
        // Other errors
        return 'other';
    }

Referenced by get(), and getCurlHeaders().

◆ checkInternetState()

checkInternetState ( )

static

Checks the current state of the internet connection.

This method attempts to reach a well-known website (e.g., www.google.com) to determine the state of the internet connection. It returns true if the connection is successful, otherwise it returns false.

Returns: bool True if the internet connection is active, false otherwise.

Definition at line 400 of file class.httpclient.php.

    {
        $connected = @fsockopen('www.google.com', 80);
        if ($connected) {
            fclose($connected);
 
            return true; // Internet connection is active
        } else {
            return false; // Internet connection is not active
        }
    }

Referenced by QuickPick\getQuickpickMenu(), and QuickPick\installModule().

◆ get()

get	(		$url,
			$headers = array() )

static

Makes a GET request to the specified URL and returns the response data.

Parameters

string	$url	The URL to request.
array	$headers	Optional additional headers to include in the request.

Returns: array The response data with 'data' key on success, or 'data' and 'error' keys on failure.

Definition at line 47 of file class.httpclient.php.

    {
        $ch = curl_init();
 
        // Parse URL to check if it's localhost
        $parsedUrl = parse_url($url);
        $isLocalhost = isset($parsedUrl['host']) && (
            $parsedUrl['host'] === 'localhost' ||
            $parsedUrl['host'] === '127.0.0.1' ||
            $parsedUrl['host'] === '::1'
        );
 
        // Set basic cURL options
        curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_VERBOSE, self::$verbose);
        curl_setopt($ch, CURLOPT_URL, $url);
 
        // Configure SSL verification - allow self-signed for localhost
        if ($isLocalhost) {
            curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
            curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
        } else {
            curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
            curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
 
            // Configure CA bundle for better compatibility
            $caBundle = self::getCABundlePath();
            if ($caBundle && file_exists($caBundle)) {
                curl_setopt($ch, CURLOPT_CAINFO, $caBundle);
            }
        }
 
        // Merge with default headers if any
        $defaultHeaders = self::getDefaultHeaders();
        $allHeaders = array_merge($defaultHeaders, $headers);
        if (!empty($allHeaders)) {
            curl_setopt($ch, CURLOPT_HTTPHEADER, $allHeaders);
        }
 
        $data = curl_exec($ch);
 
        $error = null;
        $errorCode = curl_errno($ch);
        if ($errorCode) {
            $error = curl_error($ch);
            $errorType = self::categorizeCurlError($errorCode, $error, $isLocalhost);
            Log::error('CURL Error (' . $errorType . '): ' . $error . ' (URL: ' . $url . ')');
        }
 
        // curl_close() is deprecated in PHP 8.0+ as it has no effect since PHP 8.0
        // The resource is automatically closed when it goes out of scope
        if (PHP_VERSION_ID < 80000) {
            curl_close($ch);
        }
 
        // Always return array with consistent structure
        if ($error !== null) {
            return array('data' => trim($data), 'error' => $error, 'error_type' => self::categorizeCurlError($errorCode, $error, $isLocalhost));
        }
 
        return array('data' => trim($data));
    }

References categorizeCurlError(), Log\error(), getCABundlePath(), and getDefaultHeaders().

Referenced by getApiJson().

◆ getApiHeaders()

getApiHeaders ( )

staticprivate

Gets the headers required for GitHub API requests.

Returns: array The GitHub API headers.

Definition at line 255 of file class.httpclient.php.

    {
        return array(
            'User-Agent: ' . APP_GITHUB_USERAGENT,
            'Accept: application/vnd.github.v3+json'
        );
    }

References APP_GITHUB_USERAGENT.

Referenced by getApiJson().

◆ getApiJson()

getApiJson	(		$url,
			$headers = array() )

static

Makes a request to a JSON API and returns the response data.

Parameters

string	$url	The API URL to request.
array	$headers	Optional additional headers to include in the request.

Returns: array An array with 'data' key containing the JSON response string on success, or 'data', 'error', and 'error_type' keys on failure. Structure: ['data' => string, 'error' => string, 'error_type' => string]

Definition at line 120 of file class.httpclient.php.

    {
        $apiHeaders = self::getApiHeaders();
        $allHeaders = array_merge($apiHeaders, $headers);
        return self::get($url, $allHeaders);
    }

References get(), and getApiHeaders().

Referenced by Util\getApiJson().

◆ getCABundlePath()

getCABundlePath ( )

staticprivate

Gets the path to the CA bundle file.

Returns: string|null Path to CA bundle or null if not found.

Definition at line 217 of file class.httpclient.php.

    {
        // Try common CA bundle locations
        $possiblePaths = array(
            // Windows CA store
            'C:/Windows/System32/certs/cacert.pem',
            // Common locations
            dirname(__DIR__, 2) . '/ssl/cacert.pem',
            // PHP's default location
            ini_get('curl.cainfo'),
            // Environment variable
            getenv('CURL_CA_BUNDLE'),
        );
 
        foreach ($possiblePaths as $path) {
            if ($path && file_exists($path)) {
                return $path;
            }
        }
 
        return null;
    }

Referenced by get(), and getCurlHeaders().

◆ getCurlHeaders()

getCurlHeaders	(		$url,
			$headers = array() )

static

Retrieves HTTP headers from a given URL.

Parameters

string	$url	The URL from which to fetch the headers.
array	$headers	Optional additional headers to include in the request.

Returns: array The headers array with 'headers' key on success, or 'headers' and 'error' keys on failure.

Definition at line 134 of file class.httpclient.php.

    {
        $ch = curl_init();
 
        // Parse URL to check if it's localhost
        $parsedUrl = parse_url($url);
        $isLocalhost = isset($parsedUrl['host']) && (
            $parsedUrl['host'] === 'localhost' ||
            $parsedUrl['host'] === '127.0.0.1' ||
            $parsedUrl['host'] === '::1'
        );
 
        // Set basic cURL options
        curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_VERBOSE, self::$verbose);
        curl_setopt($ch, CURLOPT_HEADER, true);
        curl_setopt($ch, CURLOPT_NOBODY, true); // HEAD request to get headers only
        curl_setopt($ch, CURLOPT_URL, $url);
 
        // Configure SSL verification - allow self-signed for localhost
        if ($isLocalhost) {
            curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
            curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
        } else {
            curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
            curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
 
            // Configure CA bundle for better compatibility
            $caBundle = self::getCABundlePath();
            if ($caBundle && file_exists($caBundle)) {
                curl_setopt($ch, CURLOPT_CAINFO, $caBundle);
            }
        }
 
        // Merge with default headers if any
        $defaultHeaders = self::getDefaultHeaders();
        $allHeaders = array_merge($defaultHeaders, $headers);
        if (!empty($allHeaders)) {
            curl_setopt($ch, CURLOPT_HTTPHEADER, $allHeaders);
        }
 
        $response = curl_exec($ch);
 
        $error = null;
        $errorCode = curl_errno($ch);
        if ($errorCode) {
            $error = curl_error($ch);
            $errorType = self::categorizeCurlError($errorCode, $error, $isLocalhost);
            Log::error('CURL Error getting headers (' . $errorType . '): ' . $error . ' (URL: ' . $url . ')');
        }
 
        // curl_close() is deprecated in PHP 8.0+ as it has no effect since PHP 8.0
        // The resource is automatically closed when it goes out of scope
        if (PHP_VERSION_ID < 80000) {
            curl_close($ch);
        }
 
        // Always return array with consistent structure
        if ($error !== null) {
            return array('headers' => array(), 'error' => $error, 'error_type' => self::categorizeCurlError($errorCode, $error, $isLocalhost));
        }
 
        // Parse headers from response
        $parsedHeaders = array();
        if (!empty($response)) {
            $responseLines = explode("\n", $response);
            foreach ($responseLines as $line) {
                $line = trim($line);
                if (!empty($line)) {
                    $parsedHeaders[] = $line;
                }
            }
        }
 
        return array('headers' => $parsedHeaders);
    }

References $response, categorizeCurlError(), Log\error(), getCABundlePath(), and getDefaultHeaders().

Referenced by getCurlHttpHeaders().

◆ getCurlHttpHeaders()

getCurlHttpHeaders ( $url )

static

Retrieves HTTP headers from a given URL using cURL.

This method uses HttpClient for secure TLS verification.

Parameters

string $url The URL from which to fetch the headers.

Returns: array An array of headers if successful, otherwise an empty array.

Definition at line 377 of file class.httpclient.php.

    {
        $result = self::getCurlHeaders($url);
 
        // Handle error response from HttpClient
        if (is_array($result) && isset($result['error'])) {
            Log::error('Failed to get headers via HttpClient::getCurlHeaders: ' . $result['error']);
            return array();
        }
 
        // Extract headers array from consistent HttpClient response structure
        return isset($result['headers']) ? $result['headers'] : array();
    }

References $result, Log\error(), and getCurlHeaders().

Referenced by getHttpHeaders().

◆ getDefaultHeaders()

getDefaultHeaders ( )

staticprivate

Gets the default headers for HTTP requests.

Returns: array The default headers.

Definition at line 245 of file class.httpclient.php.

    {
        return array();
    }

Referenced by get(), and getCurlHeaders().

◆ getFopenHttpHeaders()

getFopenHttpHeaders ( $url )

static

Retrieves HTTP headers from a given URL using the fopen function.

This method creates a stream context with SSL verification enabled for security. It attempts to open the URL and read the HTTP response headers.

Parameters

string $url The URL from which to fetch the headers.

Returns: array An array of headers if successful, otherwise an empty array.

Definition at line 346 of file class.httpclient.php.

    {
        $result = array();
 
        $context = stream_context_create(array(
            'ssl' => array(
                'verify_peer'       => true,
                'verify_peer_name'  => true,
                'allow_self_signed' => false,
            )
        ));
 
        $fp = @fopen($url, 'r', false, $context);
        if ($fp) {
            $meta   = stream_get_meta_data($fp);
            $result = isset($meta['wrapper_data']) ? $meta['wrapper_data'] : $result;
            fclose($fp);
        }
 
        return $result;
    }

References $result.

Referenced by getHttpHeaders().

◆ getHttpHeaders()

getHttpHeaders ( $pingUrl )

static

Retrieves HTTP headers from a given URL using either cURL or fopen, depending on availability.

Parameters

string $pingUrl The URL to ping for headers.

Returns: array An array of HTTP headers.

Definition at line 309 of file class.httpclient.php.

    {
        if (function_exists('curl_version')) {
            $result = self::getCurlHttpHeaders($pingUrl);
        } else {
            $result = self::getFopenHttpHeaders($pingUrl);
        }
 
        if (!empty($result)) {
            $rebuildResult = array();
            foreach ($result as $row) {
                $row = trim($row);
                if (!empty($row)) {
                    $rebuildResult[] = $row;
                }
            }
            $result = $rebuildResult;
 
            Log::debug('getHttpHeaders:');
            foreach ($result as $header) {
                Log::debug('-> ' . $header);
            }
        }
 
        return $result;
    }

References $result, Log\debug(), getCurlHttpHeaders(), and getFopenHttpHeaders().

Referenced by BinApache\checkPort().

◆ getVerbose()

getVerbose ( )

static

Gets the current verbosity setting.

Returns: bool Current verbosity setting.

Definition at line 35 of file class.httpclient.php.

    {
        return self::$verbose;
    }

◆ setVerbose()

setVerbose ( $verbose )

static

Sets the verbosity level for cURL operations.

Parameters

bool $verbose Whether to enable verbose output.

Returns: void

Definition at line 25 of file class.httpclient.php.

    {
        self::$verbose = (bool) $verbose;
    }

References $verbose.

Field Documentation

◆ $verbose

$verbose = false

staticprivate

Definition at line 17 of file class.httpclient.php.

Referenced by setVerbose().

The documentation for this class was generated from the following file:

E:/Bearsampp-development/sandbox/core/classes/class.httpclient.php

Static Public Member Functions

Static Private Member Functions

Static Private Attributes

Detailed Description

Member Function Documentation

◆ categorizeCurlError()

◆ checkInternetState()

◆ get()

◆ getApiHeaders()

◆ getApiJson()

◆ getCABundlePath()

◆ getCurlHeaders()

◆ getCurlHttpHeaders()

◆ getDefaultHeaders()

◆ getFopenHttpHeaders()

◆ getHttpHeaders()

◆ getVerbose()

◆ setVerbose()

Field Documentation

◆ $verbose