diff --git a/classes/chillerlan-HTTP-CurlHandle.html b/classes/chillerlan-HTTP-CurlHandle.html index 16a40d26..6e5629db 100644 --- a/classes/chillerlan-HTTP-CurlHandle.html +++ b/classes/chillerlan-HTTP-CurlHandle.html @@ -116,13 +116,15 @@

+
FinalYes
+
@@ -157,10 +159,10 @@

 = [\CURLE_COULDNT_RESOLVE_PROXY, \CURLE_COULDNT_RESOLVE_HOST, \CURLE_COULDNT_CONNECT, \CURLE_OPERATION_TIMEOUTED, \CURLE_SSL_CONNECT_ERROR, \CURLE_GOT_NOTHING] -
- CURLINFO_SSL_VERIFYRESULT +
+ NEVER_OVERWRITE -  = [0 => 'ok the operation was successful.', 2 => 'unable to get issuer certificate', 3 => 'unable to get certificate CRL', 4 => 'unable to decrypt certificate\'s signature', 5 => 'unable to decrypt CRL\'s signature', 6 => 'unable to decode issuer public key', 7 => 'certificate signature failure', 8 => 'CRL signature failure', 9 => 'certificate is not yet valid', 10 => 'certificate has expired', 11 => 'CRL is not yet valid', 12 => 'CRL has expired', 13 => 'format error in certificate\'s notBefore field', 14 => 'format error in certificate\'s notAfter field', 15 => 'format error in CRL\'s lastUpdate field', 16 => 'format error in CRL\'s nextUpdate field', 17 => 'out of memory', 18 => 'self signed certificate', 19 => 'self signed certificate in certificate chain', 20 => 'unable to get local issuer certificate', 21 => 'unable to verify the first certificate', 22 => 'certificate chain too long', 23 => 'certificate revoked', 24 => 'invalid CA certificate', 25 => 'path length constraint exceeded', 26 => 'unsupported certificate purpose', 27 => 'certificate not trusted', 28 => 'certificate rejected', 29 => 'subject issuer mismatch', 30 => 'authority and subject key identifier mismatch', 31 => 'authority and issuer serial number mismatch', 32 => 'key usage does not include certificate signing', 50 => 'application verification failure'] +  = [\CURLOPT_CAINFO, \CURLOPT_CAPATH, \CURLOPT_DOH_URL, \CURLOPT_CUSTOMREQUEST, \CURLOPT_HTTPHEADER, \CURLOPT_NOBODY, \CURLOPT_FORBID_REUSE, \CURLOPT_FRESH_CONNECT]
@@ -172,49 +174,55 @@

-
+
$curl -  : CurlHandle|null +  : CurlHandle
-
+
$curlOptions  : array<string|int, mixed>
-
+
+ $handleID + +  : int +
+ +
$initialized  : bool
-
+
$options  : HTTPOptions|SettingsContainerInterface
-
+
$request  : RequestInterface
-
+
$requestBody  : StreamInterface
-
+
$response  : ResponseInterface
-
+
$responseBody  : StreamInterface @@ -245,14 +253,16 @@

close() -  : static +  : self
+
closes the handle
exec()  : int
+
executes the current cURL instance and returns the error number
getCurlOptions() @@ -263,59 +273,64 @@

getCurlResource() -  : CurlHandle|null +  : CurlHandle
+
returns the internal cURL resource in its current state
getError()  : string
+
returns a string containing the last error
- getRequest() + getHandleID() -  : RequestInterface +  : int
+
returns the handle ID (cURL resource id)
- getResponse() + getInfo() -  : ResponseInterface +  : array<string|int, mixed>|null
+
returns the result from `curl_getinfo()` or `null` in case of an error
- init() + getRequest() -  : CurlHandle|null +  : RequestInterface
- setRequestOptions() + getResponse() -  : void +  : ResponseInterface
-
- initCurlOptions() +
+ init() -  : array<string|int, mixed> +  : CurlHandle|null
-
- setBodyOptions() +
+ guessCA() -  : void +  : string
+
Check default locations for the CA bundle
-
- setHeaderOptions() +
+ setCA()  : void
-
- setSSLOptions() +
+ setRequestOptions()  : void
@@ -342,7 +357,7 @@

@@ -360,10 +375,10 @@

-
-

- CURLINFO_SSL_VERIFYRESULT - +
+

+ NEVER_OVERWRITE +

@@ -376,10 +391,10 @@

- public + private mixed - CURLINFO_SSL_VERIFYRESULT - = [0 => 'ok the operation was successful.', 2 => 'unable to get issuer certificate', 3 => 'unable to get certificate CRL', 4 => 'unable to decrypt certificate\'s signature', 5 => 'unable to decrypt CRL\'s signature', 6 => 'unable to decode issuer public key', 7 => 'certificate signature failure', 8 => 'CRL signature failure', 9 => 'certificate is not yet valid', 10 => 'certificate has expired', 11 => 'CRL is not yet valid', 12 => 'CRL has expired', 13 => 'format error in certificate\'s notBefore field', 14 => 'format error in certificate\'s notAfter field', 15 => 'format error in CRL\'s lastUpdate field', 16 => 'format error in CRL\'s nextUpdate field', 17 => 'out of memory', 18 => 'self signed certificate', 19 => 'self signed certificate in certificate chain', 20 => 'unable to get local issuer certificate', 21 => 'unable to verify the first certificate', 22 => 'certificate chain too long', 23 => 'certificate revoked', 24 => 'invalid CA certificate', 25 => 'path length constraint exceeded', 26 => 'unsupported certificate purpose', 27 => 'certificate not trusted', 28 => 'certificate rejected', 29 => 'subject issuer mismatch', 30 => 'authority and subject key identifier mismatch', 31 => 'authority and issuer serial number mismatch', 32 => 'key usage does not include certificate signing', 50 => 'application verification failure'] + NEVER_OVERWRITE + = [\CURLOPT_CAINFO, \CURLOPT_CAPATH, \CURLOPT_DOH_URL, \CURLOPT_CUSTOMREQUEST, \CURLOPT_HTTPHEADER, \CURLOPT_NOBODY, \CURLOPT_FORBID_REUSE, \CURLOPT_FRESH_CONNECT] @@ -401,7 +416,7 @@

class=" phpdocumentor-element -property - -protected + -private " >

@@ -414,16 +429,16 @@

- protected - CurlHandle|null + private + CurlHandle $curl - = null + @@ -434,7 +449,7 @@

class=" phpdocumentor-element -property - -protected + -private " >

@@ -447,13 +462,13 @@

- protected + private array<string|int, mixed> $curlOptions = [] @@ -467,7 +482,40 @@

class=" phpdocumentor-element -property - -protected + -private + " +> +

+ $handleID + + + + +

+ + + + + private + int + $handleID + + + + + + +
+

@@ -480,13 +528,13 @@

- protected + private bool $initialized = false @@ -500,7 +548,7 @@

class=" phpdocumentor-element -property - -protected + -private " >

@@ -513,13 +561,13 @@

- protected + private HTTPOptions|SettingsContainerInterface $options @@ -533,7 +581,7 @@

class=" phpdocumentor-element -property - -protected + -private " >

@@ -546,13 +594,13 @@

- protected + private RequestInterface $request @@ -566,7 +614,7 @@

class=" phpdocumentor-element -property - -protected + -private " >

@@ -579,13 +627,13 @@

- protected + private StreamInterface $requestBody @@ -599,7 +647,7 @@

class=" phpdocumentor-element -property - -protected + -private " >

@@ -612,13 +660,13 @@

- protected + private ResponseInterface $response @@ -632,7 +680,7 @@

class=" phpdocumentor-element -property - -protected + -private " >

@@ -645,13 +693,13 @@

- protected + private StreamInterface $responseBody @@ -683,7 +731,7 @@

@@ -746,7 +794,7 @@

@@ -778,14 +826,15 @@

- +

closes the handle

+ public - close() : static + close() : self
@@ -795,7 +844,7 @@

Return values
- static + self

@@ -813,11 +862,12 @@

- +

executes the current cURL instance and returns the error number

+ public exec() : int @@ -827,6 +877,29 @@

+

+ Tags + + +
+
+
+ see +
+
+ curl_exec() + + +
+
+ see +
+
+ curl_errno() + + +
+
Return values
@@ -848,7 +921,7 @@

@@ -897,14 +970,15 @@

- +

returns the internal cURL resource in its current state

+ public - getCurlResource() : CurlHandle|null + getCurlResource() : CurlHandle
@@ -928,7 +1002,7 @@

Return values
- CurlHandle|null + CurlHandle
@@ -946,11 +1020,12 @@

- +

returns a string containing the last error

+ public getError() : string @@ -960,6 +1035,21 @@

+

+ Tags + + +
+
+
+ see +
+
+ curl_error() + + +
+
Return values
@@ -973,22 +1063,23 @@
Return values
-public " > -

- getRequest() - +

+ getHandleID() +

- +

returns the handle ID (cURL resource id)

+ public - getRequest() : RequestInterface + getHandleID() : int
@@ -997,7 +1088,7 @@

Tags - +
@@ -1012,7 +1103,7 @@
Return values
- RequestInterface + int
@@ -1022,22 +1113,23 @@
Return values
-public " > -

- getResponse() - +

+ getInfo() +

- +

returns the result from `curl_getinfo()` or `null` in case of an error

+ public - getResponse() : ResponseInterface + getInfo() : array<string|int, mixed>|null
@@ -1046,22 +1138,47 @@

Tags - +
- codeCoverageIgnore + see
- + curl_getinfo() + + +
+
+ see +
+
+ https://www.php.net/manual/function.curl-getinfo.php#111678 + + +
+
+ see +
+
+ https://www.openssl.org/docs/manmaster/man1/verify.html#VERIFY_OPERATION + + +
+
+ see +
+
+ https://github.com/openssl/openssl/blob/91cb81d40a8102c3d8667629661be8d6937db82b/include/openssl/x509_vfy.h#L99-L189 +
Return values
- ResponseInterface + array<string|int, mixed>|null
@@ -1071,32 +1188,46 @@
Return values
-public " > -

- init() - +

+ getRequest() +

public - init() : CurlHandle|null + getRequest() : RequestInterface
+
+ Tags + + +
+
+
+ codeCoverageIgnore +
+
+ + +
+
Return values
- CurlHandle|null + RequestInterface
@@ -1106,22 +1237,22 @@
Return values
-public " > -

- setRequestOptions() - +

+ getResponse() +

public - setRequestOptions() : void + getResponse() : ResponseInterface
@@ -1130,44 +1261,47 @@

Tags - +
- throws + codeCoverageIgnore
- ClientException - +
- +
+
Return values
+ ResponseInterface +
+
-

- initCurlOptions() - +

+ init() +

- protected - initCurlOptions() : array<string|int, mixed> + public + init() : CurlHandle|null
@@ -1176,7 +1310,7 @@

Tags - +
@@ -1191,100 +1325,173 @@
Return values
- array<string|int, mixed> + CurlHandle|null
-

- setBodyOptions() - +

+ guessCA() +

- +

Check default locations for the CA bundle

+ - protected - setBodyOptions() : void + private + guessCA() : string
+
+ Tags + + +
+
+
+ see +
+
+ https://packages.ubuntu.com/search?suite=all&searchon=names&keywords=ca-certificates + + +
+
+ see +
+
+ https://packages.debian.org/search?suite=all&searchon=names&keywords=ca-certificates + + +
+
+ codeCoverageIgnore +
+
+ + +
+
+ throws +
+
+ ClientException + + +
+
+ +
+
Return values
+ string +
-
-

- setHeaderOptions() - +

+ setCA() +

- protected - setHeaderOptions() : void + private + setCA() : void
+
+ Tags + + +
+
+
+ throws +
+
+ ClientException + + +
+
-

- setSSLOptions() - +

+ setRequestOptions() +

- protected - setSSLOptions() : void + private + setRequestOptions() : void
+
+ Tags + + +
+
+
+ throws +
+
+ ClientException + + +
+
@@ -1402,7 +1609,7 @@

  • @@ -1411,6 +1618,7 @@

    diff --git a/classes/chillerlan-HTTP-CurlMultiClient.html b/classes/chillerlan-HTTP-CurlMultiClient.html index cfca5d6b..d19571a1 100644 --- a/classes/chillerlan-HTTP-CurlMultiClient.html +++ b/classes/chillerlan-HTTP-CurlMultiClient.html @@ -111,9 +111,6 @@

    - - implements - LoggerAwareInterface

    @@ -144,13 +141,6 @@

    -

    - Interfaces - - -

    -
    -
    LoggerAwareInterface
    @@ -164,21 +154,23 @@

    - $curl_multi + $counter -  : CurlMultiHandle|null +  : int
    +
    the request counter (request ID/order in multi response handler)
    - $handleCounter + $curl_multi -  : int +  : CurlMultiHandle
    +
    the cURL multi handle instance
    $handles -  : array<string|int, CurlMultiHandle> +  : array<string|int, mixed>
    the stack of running handles
    @@ -240,29 +232,33 @@

     : static

    +
    adds a request to the stack
    addRequests()  : static
    +
    adds multiple requests to the stack
    close() -  : void +  : static
    +
    closes the handle
    process()  : static
    +
    processes the stack
    setLogger() -  : void +  : static
    @@ -270,6 +266,20 @@

     : void

    +
    creates a new request handle
    + +
    + initCurlMultiOptions() + +  : void +
    + +
    + resolve() + +  : void +
    +
    resolves the handle, calls the response handler callback and creates the next handle

    @@ -292,9 +302,9 @@

    -protected " > -

    - $curl_multi - +

    + $counter + @@ -302,16 +312,17 @@

    - +

    the request counter (request ID/order in multi response handler)

    + protected - CurlMultiHandle|null - $curl_multi - = null + int + $counter + = 0 @@ -325,9 +336,9 @@

    -protected " > -

    - $handleCounter - +

    + $curl_multi + @@ -335,16 +346,17 @@

    - +

    the cURL multi handle instance

    + protected - int - $handleCounter - = 0 + CurlMultiHandle + $curl_multi + @@ -368,7 +380,7 @@

    @@ -376,11 +388,13 @@

    protected - array<string|int, CurlMultiHandle> + array<string|int, mixed> $handles = [] - +

    cURL instance id => [counter, retries, handle]

    +
    + @@ -402,7 +416,7 @@

    @@ -435,7 +449,7 @@

    @@ -468,7 +482,7 @@

    @@ -501,7 +515,7 @@

    @@ -535,7 +549,7 @@

    @@ -573,7 +587,7 @@

    @@ -636,7 +650,7 @@

    @@ -668,11 +682,12 @@

    - +

    adds a request to the stack

    + public addRequest(RequestInterface $request) : static @@ -713,11 +728,12 @@

    - +

    adds multiple requests to the stack

    + public addRequests(array<string|int, RequestInterface$stack) : static @@ -758,14 +774,15 @@

    - +

    closes the handle

    + public - close() : void + close() : static
    @@ -773,7 +790,11 @@

    - +
    +
    Return values
    + static +
    +
    - +

    processes the stack

    + public process() : static @@ -810,15 +832,6 @@
    - phan-suppress -
    -
    - -

    PhanTypeInvalidThrowsIsInterface

    -
    - -
    -
    throws
    @@ -848,14 +861,14 @@

    public - setLogger(LoggerInterface $logger) : void + setLogger(LoggerInterface $logger) : static
    @@ -894,7 +907,11 @@

    - +
    +
    Return values
    + static +
    +
    - +

    creates a new request handle

    + protected - createHandle([RequestInterface|null $request = null ][, int|null $id = null ][, int|null $retries = null ]) : void + createHandle([RequestInterface|null $request = null ][, int|null $counter = null ][, int|null $retries = null ]) : void
    @@ -932,7 +950,7 @@
    Parameters
    - $id + $counter : int|null = null
    @@ -950,6 +968,79 @@
    Parameters
    +
    +
    +

    + initCurlMultiOptions() + + +

    + + + + + protected + initCurlMultiOptions() : void + +
    +
    + + + + + +
    +
    +

    + resolve() + + +

    + + +

    resolves the handle, calls the response handler callback and creates the next handle

    + + + protected + resolve(int $handleID) : void + +
    +
    + +
    Parameters
    +
    +
    + $handleID + : int +
    +
    + +
    +
    + + + +
    @@ -1064,8 +1155,8 @@

    Parameters
  • Properties
  • diff --git a/classes/chillerlan-HTTP-CurlMultiHandle.html b/classes/chillerlan-HTTP-CurlMultiHandle.html deleted file mode 100644 index b1abdfc7..00000000 --- a/classes/chillerlan-HTTP-CurlMultiHandle.html +++ /dev/null @@ -1,1871 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - - - -
    -

    Documentation

    - - - - - -
    - -
    -
    - - - - -
    -
    - - -
    -

    - CurlMultiHandle - - - extends CurlHandle - - -
    - in package - -
    - - -

    - -
    - - -
    - - - -

    Implements a cURL multi connection object

    - - - - - - -

    - Table of Contents - - -

    - - - - - - - -

    - Constants - - -

    -
    -
    - CURL_NETWORK_ERRORS - -  = [\CURLE_COULDNT_RESOLVE_PROXY, \CURLE_COULDNT_RESOLVE_HOST, \CURLE_COULDNT_CONNECT, \CURLE_OPERATION_TIMEOUTED, \CURLE_SSL_CONNECT_ERROR, \CURLE_GOT_NOTHING] -
    - -
    - CURLINFO_SSL_VERIFYRESULT - -  = [0 => 'ok the operation was successful.', 2 => 'unable to get issuer certificate', 3 => 'unable to get certificate CRL', 4 => 'unable to decrypt certificate\'s signature', 5 => 'unable to decrypt CRL\'s signature', 6 => 'unable to decode issuer public key', 7 => 'certificate signature failure', 8 => 'CRL signature failure', 9 => 'certificate is not yet valid', 10 => 'certificate has expired', 11 => 'CRL is not yet valid', 12 => 'CRL has expired', 13 => 'format error in certificate\'s notBefore field', 14 => 'format error in certificate\'s notAfter field', 15 => 'format error in CRL\'s lastUpdate field', 16 => 'format error in CRL\'s nextUpdate field', 17 => 'out of memory', 18 => 'self signed certificate', 19 => 'self signed certificate in certificate chain', 20 => 'unable to get local issuer certificate', 21 => 'unable to verify the first certificate', 22 => 'certificate chain too long', 23 => 'certificate revoked', 24 => 'invalid CA certificate', 25 => 'path length constraint exceeded', 26 => 'unsupported certificate purpose', 27 => 'certificate not trusted', 28 => 'certificate rejected', 29 => 'subject issuer mismatch', 30 => 'authority and subject key identifier mismatch', 31 => 'authority and issuer serial number mismatch', 32 => 'key usage does not include certificate signing', 50 => 'application verification failure'] -
    - -
    - - -

    - Properties - - -

    -
    -
    - $curl - -  : CurlHandle|null -
    - -
    - $curlOptions - -  : array<string|int, mixed> -
    - -
    - $id - -  : int|null -
    -
    a handle ID (counter), used in CurlMultiClient
    - -
    - $initialized - -  : bool -
    - -
    - $multiResponseHandler - -  : MultiResponseHandlerInterface -
    - -
    - $options - -  : HTTPOptions|SettingsContainerInterface -
    - -
    - $request - -  : RequestInterface -
    - -
    - $requestBody - -  : StreamInterface -
    - -
    - $response - -  : ResponseInterface -
    - -
    - $responseBody - -  : StreamInterface -
    - -
    - $retries - -  : int -
    -
    a retry counter, used in CurlMultiClient
    - -
    - -

    - Methods - - -

    -
    -
    - __construct() - -  : mixed -
    -
    CurlHandle constructor.
    - -
    - __destruct() - -  : mixed -
    -
    close an existing cURL handle on exit
    - -
    - addRetry() - -  : int -
    - -
    - close() - -  : static -
    - -
    - exec() - -  : int -
    - -
    - getCurlOptions() - -  : array<string|int, mixed> -
    - -
    - getCurlResource() - -  : CurlHandle|null -
    - -
    - getError() - -  : string -
    - -
    - getID() - -  : int|null -
    - -
    - getRequest() - -  : RequestInterface -
    - -
    - getResponse() - -  : ResponseInterface -
    - -
    - getRetries() - -  : int -
    - -
    - handleResponse() - -  : RequestInterface|null -
    - -
    - init() - -  : CurlHandle|null -
    - -
    - setID() - -  : static -
    - -
    - setRequestOptions() - -  : void -
    - -
    - setRetries() - -  : static -
    - -
    - initCurlOptions() - -  : array<string|int, mixed> -
    - -
    - setBodyOptions() - -  : void -
    - -
    - setHeaderOptions() - -  : void -
    - -
    - setSSLOptions() - -  : void -
    - -
    - - - - - -
    -

    - Constants - - -

    -
    -

    - CURL_NETWORK_ERRORS - - -

    - - - - - - public - mixed - CURL_NETWORK_ERRORS - = [\CURLE_COULDNT_RESOLVE_PROXY, \CURLE_COULDNT_RESOLVE_HOST, \CURLE_COULDNT_CONNECT, \CURLE_OPERATION_TIMEOUTED, \CURLE_SSL_CONNECT_ERROR, \CURLE_GOT_NOTHING] - - - - - - - -
    -
    -

    - CURLINFO_SSL_VERIFYRESULT - - -

    - - - - - - public - mixed - CURLINFO_SSL_VERIFYRESULT - = [0 => 'ok the operation was successful.', 2 => 'unable to get issuer certificate', 3 => 'unable to get certificate CRL', 4 => 'unable to decrypt certificate\'s signature', 5 => 'unable to decrypt CRL\'s signature', 6 => 'unable to decode issuer public key', 7 => 'certificate signature failure', 8 => 'CRL signature failure', 9 => 'certificate is not yet valid', 10 => 'certificate has expired', 11 => 'CRL is not yet valid', 12 => 'CRL has expired', 13 => 'format error in certificate\'s notBefore field', 14 => 'format error in certificate\'s notAfter field', 15 => 'format error in CRL\'s lastUpdate field', 16 => 'format error in CRL\'s nextUpdate field', 17 => 'out of memory', 18 => 'self signed certificate', 19 => 'self signed certificate in certificate chain', 20 => 'unable to get local issuer certificate', 21 => 'unable to verify the first certificate', 22 => 'certificate chain too long', 23 => 'certificate revoked', 24 => 'invalid CA certificate', 25 => 'path length constraint exceeded', 26 => 'unsupported certificate purpose', 27 => 'certificate not trusted', 28 => 'certificate rejected', 29 => 'subject issuer mismatch', 30 => 'authority and subject key identifier mismatch', 31 => 'authority and issuer serial number mismatch', 32 => 'key usage does not include certificate signing', 50 => 'application verification failure'] - - - - - - - -
    -
    - - -
    -

    - Properties - - -

    -
    -

    - $curl - - - - -

    - - - - - protected - CurlHandle|null - $curl - = null - - - - - -
    -
    -

    - $curlOptions - - - - -

    - - - - - protected - array<string|int, mixed> - $curlOptions - = [] - - - - - -
    -
    -

    - $id - - - - -

    - - -

    a handle ID (counter), used in CurlMultiClient

    - - - protected - int|null - $id - = null - - - - - -
    -
    -

    - $initialized - - - - -

    - - - - - protected - bool - $initialized - = false - - - - - -
    - -
    -

    - $options - - - - -

    - - - - - protected - HTTPOptions|SettingsContainerInterface - $options - - - - - - -
    -
    -

    - $request - - - - -

    - - - - - protected - RequestInterface - $request - - - - - - -
    -
    -

    - $requestBody - - - - -

    - - - - - protected - StreamInterface - $requestBody - - - - - - -
    -
    -

    - $response - - - - -

    - - - - - protected - ResponseInterface - $response - - - - - - -
    -
    -

    - $responseBody - - - - -

    - - - - - protected - StreamInterface - $responseBody - - - - - - -
    -
    -

    - $retries - - - - -

    - - -

    a retry counter, used in CurlMultiClient

    - - - protected - int - $retries - = 0 - - - - - -
    -
    - -
    -

    - Methods - - -

    -
    -

    - __construct() - - -

    - - -

    CurlHandle constructor.

    - - - public - __construct(MultiResponseHandlerInterface $multiResponseHandler, RequestInterface $request, ResponseInterface $response, SettingsContainerInterface $options) : mixed - -
    -
    - -
    Parameters
    -
    -
    - $multiResponseHandler - : MultiResponseHandlerInterface -
    -
    - -
    -
    - $request - : RequestInterface -
    -
    - -
    -
    - $response - : ResponseInterface -
    -
    - -
    -
    - $options - : SettingsContainerInterface -
    -
    - -
    -
    - - - - -
    -
    -

    - __destruct() - - -

    - - -

    close an existing cURL handle on exit

    - - - public - __destruct() : mixed - -
    -
    - - - - - -
    -
    -

    - addRetry() - - -

    - - - - - public - addRetry() : int - -
    -
    - - - - -
    -
    Return values
    - int -
    - -
    -
    -

    - close() - - -

    - - - - - public - close() : static - -
    -
    - - - - -
    -
    Return values
    - static -
    - -
    -
    -

    - exec() - - -

    - - - - - public - exec() : int - -
    -
    - - - - -
    -
    Return values
    - int -
    - -
    -
    -

    - getCurlOptions() - - -

    - - - - - public - getCurlOptions() : array<string|int, mixed> - -
    -
    - - - -
    - Tags - - -
    -
    -
    - codeCoverageIgnore -
    -
    - - -
    -
    - -
    -
    Return values
    - array<string|int, mixed> -
    - -
    -
    -

    - getCurlResource() - - -

    - - - - - public - getCurlResource() : CurlHandle|null - -
    -
    - - - -
    - Tags - - -
    -
    -
    - codeCoverageIgnore -
    -
    - - -
    -
    - -
    -
    Return values
    - CurlHandle|null -
    - -
    -
    -

    - getError() - - -

    - - - - - public - getError() : string - -
    -
    - - - - -
    -
    Return values
    - string -
    - -
    -
    -

    - getID() - - -

    - - - - - public - getID() : int|null - -
    -
    - - - - -
    -
    Return values
    - int|null -
    - -
    -
    -

    - getRequest() - - -

    - - - - - public - getRequest() : RequestInterface - -
    -
    - - - -
    - Tags - - -
    -
    -
    - codeCoverageIgnore -
    -
    - - -
    -
    - -
    -
    Return values
    - RequestInterface -
    - -
    -
    -

    - getResponse() - - -

    - - - - - public - getResponse() : ResponseInterface - -
    -
    - - - -
    - Tags - - -
    -
    -
    - codeCoverageIgnore -
    -
    - - -
    -
    - -
    -
    Return values
    - ResponseInterface -
    - -
    -
    -

    - getRetries() - - -

    - - - - - public - getRetries() : int - -
    -
    - - - - -
    -
    Return values
    - int -
    - -
    -
    -

    - handleResponse() - - -

    - - - - - public - handleResponse() : RequestInterface|null - -
    -
    - - - - -
    -
    Return values
    - RequestInterface|null -
    - -
    -
    -

    - init() - - -

    - - - - - public - init() : CurlHandle|null - -
    -
    - - - - -
    -
    Return values
    - CurlHandle|null -
    - -
    -
    -

    - setID() - - -

    - - - - - public - setID(int $id) : static - -
    -
    - -
    Parameters
    -
    -
    - $id - : int -
    -
    - -
    -
    - - - -
    -
    Return values
    - static -
    - -
    -
    -

    - setRequestOptions() - - -

    - - - - - public - setRequestOptions() : void - -
    -
    - - - -
    - Tags - - -
    -
    -
    - throws -
    -
    - ClientException - - -
    -
    - - -
    -
    -

    - setRetries() - - -

    - - - - - public - setRetries(int $retries) : static - -
    -
    - -
    Parameters
    -
    -
    - $retries - : int -
    -
    - -
    -
    - - - -
    -
    Return values
    - static -
    - -
    - -
    -

    - setBodyOptions() - - -

    - - - - - protected - setBodyOptions() : void - -
    -
    - - - - - -
    -
    -

    - setHeaderOptions() - - -

    - - - - - protected - setHeaderOptions() : void - -
    -
    - - - - - -
    -
    -

    - setSSLOptions() - - -

    - - - - - protected - setSSLOptions() : void - -
    -
    - - - - - -
    -
    - -
    -
    -
    -
    -
    
    -        
    - -
    -
    - - - -
    -
    -
    - -
    - On this page - - -
    - -
    -
    -
    -
    -
    -

    Search results

    - -
    -
    -
      -
      -
      -
      -
      - - -
      - - - - - - - - diff --git a/classes/chillerlan-HTTP-HTTPOptions.html b/classes/chillerlan-HTTP-HTTPOptions.html index fcf392ae..becb9736 100644 --- a/classes/chillerlan-HTTP-HTTPOptions.html +++ b/classes/chillerlan-HTTP-HTTPOptions.html @@ -163,7 +163,7 @@

       : string|null -
      CA Root Certificates for use with CURL/SSL (if not configured in php.ini or available in a default path)
      +
      CA Root Certificates for use with CURL/SSL
      $curl_check_OCSP @@ -186,6 +186,13 @@

      options for each curl instance
      +
      + $dns_over_https + +  : string|null +
      +
      Sets a DNS-over-HTTPS provider URL
      +
      $retries @@ -196,7 +203,7 @@

      $sleep -  : int|null +  : int
      sleep timer (microseconds) between each fired multi request on startup
      @@ -237,19 +244,6 @@

      -
      - checkCA() - -  : bool -
      -
      Check whether the given CA info exists and if it is file or dir
      - -
      - set_ca_info() - -  : void -
      -
      set_curl_options() @@ -257,13 +251,13 @@

      - set_user_agent() + set_dns_over_https()  : void
      - setCA() + set_user_agent()  : void
      @@ -299,11 +293,11 @@

      -

      CA Root Certificates for use with CURL/SSL (if not configured in php.ini or available in a default path)

      +

      CA Root Certificates for use with CURL/SSL

      protected @@ -311,7 +305,9 @@

      $ca_info = null - +

      (if not configured in php.ini or available in a default path via the ca-certificates package)

      +
      +

      @@ -361,7 +357,7 @@

      @@ -414,7 +410,7 @@

      @@ -481,6 +477,70 @@

      + +
      @@ -533,7 +593,7 @@

      @@ -541,9 +601,9 @@

      protected - int|null + int $sleep - = null + = 0 @@ -567,7 +627,7 @@

      @@ -616,7 +676,7 @@

      @@ -699,7 +759,7 @@

      @@ -730,84 +790,22 @@

      -protected " > -

      - checkCA() - - -

      - - -

      Check whether the given CA info exists and if it is file or dir

      - - - protected - checkCA([string|null $ca = null ]) : bool - -
      -
      - -
      Parameters
      -
      -
      - $ca - : string|null - = null
      -
      - -
      -
      - - -
      - Tags - - -
      -
      -
      - phan-suppress -
      -
      - -

      PhanTypeMismatchArgumentNullableInternal

      -
      - -
      -
      - -
      -
      Return values
      - bool -
      - -
      -
      -

      - set_ca_info() - +

      + set_curl_options() +

      protected - set_ca_info([string|null $ca_info = null ]) : void + set_curl_options(array<string|int, mixed> $curl_options) : void
      @@ -815,9 +813,9 @@

      Parameters
      - $ca_info - : string|null - = null
      + $curl_options + : array<string|int, mixed> +

      @@ -833,22 +831,22 @@

      Parameters
      -protected " > -

      - set_curl_options() - +

      + set_dns_over_https() +

      protected - set_curl_options(array<string|int, mixed> $curl_options) : void + set_dns_over_https(string|null $dns_over_https) : void
      @@ -856,8 +854,8 @@

      Parameters
      - $curl_options - : array<string|int, mixed> + $dns_over_https + : string|null
      @@ -882,7 +880,7 @@

      @@ -923,62 +921,6 @@

      - -
      -

      - setCA() - - -

      - - - - - protected - setCA([string|null $ca_info = null ]) : void - -
      -
      - -
      Parameters
      -
      -
      - $ca_info - : string|null - = null
      -
      - -
      -
      - - -
      - Tags - - -
      -
      -
      - throws -
      -
      - ClientExceptionInterface - - -
      -
      - -
      @@ -1097,6 +1039,7 @@
    • $curl_check_OCSP
    • $curl_multi_options
    • $curl_options
    • +
    • $dns_over_https
    • $retries
    • $sleep
    • $ssl_verifypeer
    • @@ -1109,11 +1052,9 @@
    • Methods
    • diff --git a/classes/chillerlan-HTTP-HTTPOptionsTrait.html b/classes/chillerlan-HTTP-HTTPOptionsTrait.html index 493e0e4d..8ddeb9cc 100644 --- a/classes/chillerlan-HTTP-HTTPOptionsTrait.html +++ b/classes/chillerlan-HTTP-HTTPOptionsTrait.html @@ -142,7 +142,7 @@

       : string|null -
      CA Root Certificates for use with CURL/SSL (if not configured in php.ini or available in a default path)
      +
      CA Root Certificates for use with CURL/SSL
      $curl_check_OCSP @@ -165,6 +165,13 @@

      options for each curl instance
      +
      + $dns_over_https + +  : string|null +
      +
      Sets a DNS-over-HTTPS provider URL
      +
      $retries @@ -175,7 +182,7 @@

      $sleep -  : int|null +  : int
      sleep timer (microseconds) between each fired multi request on startup
      @@ -216,19 +223,6 @@

      -
      - checkCA() - -  : bool -
      -
      Check whether the given CA info exists and if it is file or dir
      - -
      - set_ca_info() - -  : void -
      -
      set_curl_options() @@ -236,13 +230,13 @@

      - set_user_agent() + set_dns_over_https()  : void
      - setCA() + set_user_agent()  : void
      @@ -278,11 +272,11 @@

      -

      CA Root Certificates for use with CURL/SSL (if not configured in php.ini or available in a default path)

      +

      CA Root Certificates for use with CURL/SSL

      protected @@ -290,7 +284,9 @@

      $ca_info = null - +

      (if not configured in php.ini or available in a default path via the ca-certificates package)

      +
      +

      @@ -340,7 +336,7 @@

      @@ -393,7 +389,7 @@

      @@ -460,6 +456,70 @@

      + +
      @@ -512,7 +572,7 @@

      @@ -520,9 +580,9 @@

      protected - int|null + int $sleep - = null + = 0 @@ -546,7 +606,7 @@

      @@ -595,7 +655,7 @@

      @@ -678,7 +738,7 @@

      @@ -709,84 +769,22 @@

      -protected " > -

      - checkCA() - - -

      - - -

      Check whether the given CA info exists and if it is file or dir

      - - - protected - checkCA([string|null $ca = null ]) : bool - -
      -
      - -
      Parameters
      -
      -
      - $ca - : string|null - = null
      -
      - -
      -
      - - -
      - Tags - - -
      -
      -
      - phan-suppress -
      -
      - -

      PhanTypeMismatchArgumentNullableInternal

      -
      - -
      -
      - -
      -
      Return values
      - bool -
      - -
      -
      -

      - set_ca_info() - +

      + set_curl_options() +

      protected - set_ca_info([string|null $ca_info = null ]) : void + set_curl_options(array<string|int, mixed> $curl_options) : void
      @@ -794,9 +792,9 @@

      Parameters
      - $ca_info - : string|null - = null
      + $curl_options + : array<string|int, mixed> +

      @@ -812,22 +810,22 @@

      Parameters
      -protected " > -

      - set_curl_options() - +

      + set_dns_over_https() +

      protected - set_curl_options(array<string|int, mixed> $curl_options) : void + set_dns_over_https(string|null $dns_over_https) : void
      @@ -835,8 +833,8 @@

      Parameters
      - $curl_options - : array<string|int, mixed> + $dns_over_https + : string|null
      @@ -861,7 +859,7 @@

      @@ -902,62 +900,6 @@

      - -
      -

      - setCA() - - -

      - - - - - protected - setCA([string|null $ca_info = null ]) : void - -
      -
      - -
      Parameters
      -
      -
      - $ca_info - : string|null - = null
      -
      - -
      -
      - - -
      - Tags - - -
      -
      -
      - throws -
      -
      - ClientExceptionInterface - - -
      -
      - -
      @@ -1075,6 +1017,7 @@
    • $curl_check_OCSP
    • $curl_multi_options
    • $curl_options
    • +
    • $dns_over_https
    • $retries
    • $sleep
    • $ssl_verifypeer
    • @@ -1086,11 +1029,9 @@
    • Methods
    • diff --git a/classes/chillerlan-HTTP-MultiResponseHandlerInterface.html b/classes/chillerlan-HTTP-MultiResponseHandlerInterface.html index b5ebb976..30032673 100644 --- a/classes/chillerlan-HTTP-MultiResponseHandlerInterface.html +++ b/classes/chillerlan-HTTP-MultiResponseHandlerInterface.html @@ -187,7 +187,7 @@

      public - handleResponse(ResponseInterface $response, RequestInterface $request, int $id, array<string|int, mixed> $curl_info) : RequestInterface|null + handleResponse(ResponseInterface $response, RequestInterface $request, int $id, array<string|int, mixed>|null $curl_info) : RequestInterface|null
      @@ -226,7 +226,7 @@

      Parameters
      $curl_info - : array<string|int, mixed> + : array<string|int, mixed>|null

      curl_info() result for the current request, diff --git a/classes/chillerlan-HTTPTest-CurlHandleTest.html b/classes/chillerlan-HTTPTest-CurlHandleTest.html index e70fa396..28c2ee4d 100644 --- a/classes/chillerlan-HTTPTest-CurlHandleTest.html +++ b/classes/chillerlan-HTTPTest-CurlHandleTest.html @@ -128,7 +128,7 @@

      @@ -220,6 +220,18 @@

      +
      + caOptionProvider() + +  : array<string|int, mixed> +
      + +
      + invalidCaOptionProvider() + +  : array<string|int, mixed> +
      +
      requestMethodProvider() @@ -232,6 +244,18 @@

       : array<string|int, mixed>

      +
      + testCaInfoFile() + +  : void +
      + +
      + testInvalidCAException() + +  : void +
      +
      testLargeBody() @@ -256,6 +280,12 @@

       : void

      +
      + createHandle() + +  : CurlHandle +
      +
      initFactories() @@ -299,7 +329,7 @@

      @@ -592,6 +622,76 @@

      -method -public -static " +> +

      + caOptionProvider() + + +

      + + + + + public + static caOptionProvider() : array<string|int, mixed> + +
      +
      + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + + +
      +

      + invalidCaOptionProvider() + + +

      + + + + + public + static invalidCaOptionProvider() : array<string|int, mixed> + +
      +
      + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +

      requestMethodProvider() @@ -601,7 +701,7 @@

      @@ -636,7 +736,7 @@

      CurlHandleTest.php : - 80 + 132 @@ -656,6 +756,123 @@

      Return values
      array<string|int, mixed>
      + +
      +

      + testCaInfoFile() + + +

      + + + + + public + testCaInfoFile(string $option, mixed $value, string $expectedPath, int $curl_opt, int $curl_opt_not) : void + +
      +
      + +
      Parameters
      +
      +
      + $option + : string +
      +
      + +
      +
      + $value + : mixed +
      +
      + +
      +
      + $expectedPath + : string +
      +
      + +
      +
      + $curl_opt + : int +
      +
      + +
      +
      + $curl_opt_not + : int +
      +
      + +
      +
      + + + + +
      +
      +

      + testInvalidCAException() + + +

      + + + + + public + testInvalidCAException(string $option, mixed $value) : void + +
      +
      + +
      Parameters
      +
      +
      + $option + : string +
      +
      + +
      +
      + $value + : mixed +
      +
      + +
      +
      + + + +
      @@ -702,7 +919,7 @@

      @@ -743,7 +960,7 @@

      CurlHandleTest.php : - 89 + 141 @@ -784,7 +1001,7 @@

      CurlHandleTest.php : - 121 + 171 @@ -810,6 +1027,58 @@

      Parameters
      +
      +
      +

      + createHandle() + + +

      + + + + + protected + createHandle(HTTPOptions $options[, string $method = 'GET' ]) : CurlHandle + +
      +
      + +
      Parameters
      +
      +
      + $options + : HTTPOptions +
      +
      + +
      +
      + $method + : string + = 'GET'
      +
      + +
      +
      + + + +
      +
      Return values
      + CurlHandle +
      +
      @@ -1016,12 +1285,17 @@

    • Methods
    • diff --git a/classes/chillerlan-HTTPTest-CurlMultiClientTest.html b/classes/chillerlan-HTTPTest-CurlMultiClientTest.html index 6dec5e66..63bdcc50 100644 --- a/classes/chillerlan-HTTPTest-CurlMultiClientTest.html +++ b/classes/chillerlan-HTTPTest-CurlMultiClientTest.html @@ -128,7 +128,7 @@

      @@ -293,7 +293,7 @@

      @@ -326,7 +326,7 @@

      @@ -628,7 +628,7 @@

      @@ -659,7 +659,7 @@

      @@ -704,7 +704,7 @@

      @@ -739,7 +739,7 @@

      @@ -820,7 +820,7 @@

      diff --git a/classes/chillerlan-HTTPTest-HTTPOptionsTest.html b/classes/chillerlan-HTTPTest-HTTPOptionsTest.html index 04886d30..e52c6627 100644 --- a/classes/chillerlan-HTTPTest-HTTPOptionsTest.html +++ b/classes/chillerlan-HTTPTest-HTTPOptionsTest.html @@ -214,48 +214,12 @@

      -
      - testCaInfoDir() - -  : void -
      - -
      - testCaInfoFile() - -  : void -
      - -
      - testCaInfoInvalidException() - -  : void -
      - -
      - testCurloptCaInfoInvalidException() - -  : void -
      - -
      - testInvalidCAException() - -  : void -
      -
      testInvalidUserAgentException()  : void
      -
      - testSetVerifyPeer() - -  : void -
      -
      createTestHandleOptions() @@ -565,161 +529,6 @@

      -method -public " -> -

      - testCaInfoDir() - - -

      - - - - - public - testCaInfoDir() : void - -
      -
      - - - - - -
    • -
      -

      - testCaInfoFile() - - -

      - - - - - public - testCaInfoFile() : void - -
      -
      - - - - - -
      -
      -

      - testCaInfoInvalidException() - - -

      - - - - - public - testCaInfoInvalidException() : void - -
      -
      - - - - - -
      -
      -

      - testCurloptCaInfoInvalidException() - - -

      - - - - - public - testCurloptCaInfoInvalidException() : void - -
      -
      - - - - - -
      -
      -

      - testInvalidCAException() - - -

      - - - - - public - testInvalidCAException() : void - -
      -
      - - - - - -
      -

      testInvalidUserAgentException() @@ -745,37 +554,6 @@

      -

      - testSetVerifyPeer() - - -

      - - - - - public - testSetVerifyPeer() : void - -
      -
      - - - - -
    • Methods
      • -
      • testCaInfoDir()
      • -
      • testCaInfoFile()
      • -
      • testCaInfoInvalidException()
      • -
      • testCurloptCaInfoInvalidException()
      • -
      • testInvalidCAException()
      • testInvalidUserAgentException()
      • -
      • testSetVerifyPeer()
      • createTestHandleOptions()
      • initFactories()
      • setUp()
      • diff --git a/files/src-curlmultihandle.html b/files/src-curlmultihandle.html deleted file mode 100644 index 5f7ca692..00000000 --- a/files/src-curlmultihandle.html +++ /dev/null @@ -1,319 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - - - -
        -

        Documentation

        - - - - - -
        - -
        -
        - - - - -
        -
        -
          -
        - -
        -

        CurlMultiHandle.php

        - -

        Class CurlMultiHandle

        - - - -
        - Tags - - -
        -
        -
        - created -
        -
        - -

        03.11.2020

        -
        - -
        -
        - author -
        -
        - -

        smiley smiley@chillerlan.net

        -
        - -
        -
        - copyright -
        -
        - -

        2020 smiley

        -
        - -
        -
        - license -
        -
        - -

        MIT

        -
        - -
        -
        - - - -

        - Table of Contents - - -

        - - - - -

        - Classes - - -

        -
        -
        CurlMultiHandle
        Implements a cURL multi connection object
        - - - - - - - - - - - - - -
        -
        -
        -
        -
        
        -        
        - -
        -
        - - - -
        -
        -
        - -
        - On this page - -
          -
        • Table Of Contents
        • -
        • - -
        • - - -
        -
        - -
        -
        -
        -
        -
        -

        Search results

        - -
        -
        -
          -
          -
          -
          -
          - - -
          - - - - - - - - diff --git a/indices/files.html b/indices/files.html index fea0b021..7bd0baa1 100644 --- a/indices/files.html +++ b/indices/files.html @@ -106,7 +106,6 @@

          C

        • CurlHandleTest.php
        • CurlMultiClient.php
        • CurlMultiClientTest.php
        • -
        • CurlMultiHandle.php

        F

          diff --git a/js/searchIndex.js b/js/searchIndex.js index eda1b7bb..78c115a0 100644 --- a/js/searchIndex.js +++ b/js/searchIndex.js @@ -38,13 +38,23 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003Aclose\u0028\u0029", "name": "close", - "summary": "", + "summary": "closes\u0020the\u0020handle", "url": "classes/chillerlan-HTTP-CurlHandle.html#method_close" }, { "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003AgetCurlResource\u0028\u0029", "name": "getCurlResource", - "summary": "", + "summary": "returns\u0020the\u0020internal\u0020cURL\u0020resource\u0020in\u0020its\u0020current\u0020state", "url": "classes/chillerlan-HTTP-CurlHandle.html#method_getCurlResource" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003AgetHandleID\u0028\u0029", + "name": "getHandleID", + "summary": "returns\u0020the\u0020handle\u0020ID\u0020\u0028cURL\u0020resource\u0020id\u0029", + "url": "classes/chillerlan-HTTP-CurlHandle.html#method_getHandleID" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003AgetInfo\u0028\u0029", + "name": "getInfo", + "summary": "returns\u0020the\u0020result\u0020from\u0020\u0060curl_getinfo\u0028\u0029\u0060\u0020or\u0020\u0060null\u0060\u0020in\u0020case\u0020of\u0020an\u0020error", + "url": "classes/chillerlan-HTTP-CurlHandle.html#method_getInfo" }, { "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003AgetRequest\u0028\u0029", "name": "getRequest", @@ -61,25 +71,15 @@ Search.appendIndex( "summary": "", "url": "classes/chillerlan-HTTP-CurlHandle.html#method_getCurlOptions" }, { - "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003AinitCurlOptions\u0028\u0029", - "name": "initCurlOptions", - "summary": "", - "url": "classes/chillerlan-HTTP-CurlHandle.html#method_initCurlOptions" - }, { - "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003AsetBodyOptions\u0028\u0029", - "name": "setBodyOptions", - "summary": "", - "url": "classes/chillerlan-HTTP-CurlHandle.html#method_setBodyOptions" - }, { - "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003AsetSSLOptions\u0028\u0029", - "name": "setSSLOptions", - "summary": "", - "url": "classes/chillerlan-HTTP-CurlHandle.html#method_setSSLOptions" + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003AguessCA\u0028\u0029", + "name": "guessCA", + "summary": "Check\u0020default\u0020locations\u0020for\u0020the\u0020CA\u0020bundle", + "url": "classes/chillerlan-HTTP-CurlHandle.html#method_guessCA" }, { - "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003AsetHeaderOptions\u0028\u0029", - "name": "setHeaderOptions", + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003AsetCA\u0028\u0029", + "name": "setCA", "summary": "", - "url": "classes/chillerlan-HTTP-CurlHandle.html#method_setHeaderOptions" + "url": "classes/chillerlan-HTTP-CurlHandle.html#method_setCA" }, { "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003AsetRequestOptions\u0028\u0029", "name": "setRequestOptions", @@ -93,12 +93,12 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003Aexec\u0028\u0029", "name": "exec", - "summary": "", + "summary": "executes\u0020the\u0020current\u0020cURL\u0020instance\u0020and\u0020returns\u0020the\u0020error\u0020number", "url": "classes/chillerlan-HTTP-CurlHandle.html#method_exec" }, { "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003AgetError\u0028\u0029", "name": "getError", - "summary": "", + "summary": "returns\u0020a\u0020string\u0020containing\u0020the\u0020last\u0020error", "url": "classes/chillerlan-HTTP-CurlHandle.html#method_getError" }, { "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003ACURL_NETWORK_ERRORS", @@ -106,15 +106,20 @@ Search.appendIndex( "summary": "", "url": "classes/chillerlan-HTTP-CurlHandle.html#constant_CURL_NETWORK_ERRORS" }, { - "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003ACURLINFO_SSL_VERIFYRESULT", - "name": "CURLINFO_SSL_VERIFYRESULT", + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003ANEVER_OVERWRITE", + "name": "NEVER_OVERWRITE", "summary": "", - "url": "classes/chillerlan-HTTP-CurlHandle.html#constant_CURLINFO_SSL_VERIFYRESULT" + "url": "classes/chillerlan-HTTP-CurlHandle.html#constant_NEVER_OVERWRITE" }, { "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003A\u0024curl", "name": "curl", "summary": "", "url": "classes/chillerlan-HTTP-CurlHandle.html#property_curl" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003A\u0024handleID", + "name": "handleID", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlHandle.html#property_handleID" }, { "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003A\u0024curlOptions", "name": "curlOptions", @@ -160,6 +165,11 @@ Search.appendIndex( "name": "__construct", "summary": "CurlMultiClient\u0020constructor.", "url": "classes/chillerlan-HTTP-CurlMultiClient.html#method___construct" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003AinitCurlMultiOptions\u0028\u0029", + "name": "initCurlMultiOptions", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlMultiClient.html#method_initCurlMultiOptions" }, { "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003A__destruct\u0028\u0029", "name": "__destruct", @@ -173,38 +183,38 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003Aclose\u0028\u0029", "name": "close", - "summary": "", + "summary": "closes\u0020the\u0020handle", "url": "classes/chillerlan-HTTP-CurlMultiClient.html#method_close" }, { "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003AaddRequest\u0028\u0029", "name": "addRequest", - "summary": "", + "summary": "adds\u0020a\u0020request\u0020to\u0020the\u0020stack", "url": "classes/chillerlan-HTTP-CurlMultiClient.html#method_addRequest" }, { "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003AaddRequests\u0028\u0029", "name": "addRequests", - "summary": "", + "summary": "adds\u0020multiple\u0020requests\u0020to\u0020the\u0020stack", "url": "classes/chillerlan-HTTP-CurlMultiClient.html#method_addRequests" }, { "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003Aprocess\u0028\u0029", "name": "process", - "summary": "", + "summary": "processes\u0020the\u0020stack", "url": "classes/chillerlan-HTTP-CurlMultiClient.html#method_process" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003Aresolve\u0028\u0029", + "name": "resolve", + "summary": "resolves\u0020the\u0020handle,\u0020calls\u0020the\u0020response\u0020handler\u0020callback\u0020and\u0020creates\u0020the\u0020next\u0020handle", + "url": "classes/chillerlan-HTTP-CurlMultiClient.html#method_resolve" }, { "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003AcreateHandle\u0028\u0029", "name": "createHandle", - "summary": "", + "summary": "creates\u0020a\u0020new\u0020request\u0020handle", "url": "classes/chillerlan-HTTP-CurlMultiClient.html#method_createHandle" }, { "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003A\u0024curl_multi", "name": "curl_multi", - "summary": "", + "summary": "the\u0020cURL\u0020multi\u0020handle\u0020instance", "url": "classes/chillerlan-HTTP-CurlMultiClient.html#property_curl_multi" - }, { - "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003A\u0024handleCounter", - "name": "handleCounter", - "summary": "", - "url": "classes/chillerlan-HTTP-CurlMultiClient.html#property_handleCounter" }, { "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003A\u0024requests", "name": "requests", @@ -215,6 +225,11 @@ Search.appendIndex( "name": "handles", "summary": "the\u0020stack\u0020of\u0020running\u0020handles", "url": "classes/chillerlan-HTTP-CurlMultiClient.html#property_handles" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003A\u0024counter", + "name": "counter", + "summary": "the\u0020request\u0020counter\u0020\u0028request\u0020ID\/order\u0020in\u0020multi\u0020response\u0020handler\u0029", + "url": "classes/chillerlan-HTTP-CurlMultiClient.html#property_counter" }, { "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003A\u0024multiResponseHandler", "name": "multiResponseHandler", @@ -235,61 +250,6 @@ Search.appendIndex( "name": "logger", "summary": "", "url": "classes/chillerlan-HTTP-CurlMultiClient.html#property_logger" - }, { - "fqsen": "\\chillerlan\\HTTP\\CurlMultiHandle", - "name": "CurlMultiHandle", - "summary": "Implements\u0020a\u0020cURL\u0020multi\u0020connection\u0020object", - "url": "classes/chillerlan-HTTP-CurlMultiHandle.html" - }, { - "fqsen": "\\chillerlan\\HTTP\\CurlMultiHandle\u003A\u003A__construct\u0028\u0029", - "name": "__construct", - "summary": "CurlHandle\u0020constructor.", - "url": "classes/chillerlan-HTTP-CurlMultiHandle.html#method___construct" - }, { - "fqsen": "\\chillerlan\\HTTP\\CurlMultiHandle\u003A\u003AgetID\u0028\u0029", - "name": "getID", - "summary": "", - "url": "classes/chillerlan-HTTP-CurlMultiHandle.html#method_getID" - }, { - "fqsen": "\\chillerlan\\HTTP\\CurlMultiHandle\u003A\u003AsetID\u0028\u0029", - "name": "setID", - "summary": "", - "url": "classes/chillerlan-HTTP-CurlMultiHandle.html#method_setID" - }, { - "fqsen": "\\chillerlan\\HTTP\\CurlMultiHandle\u003A\u003AgetRetries\u0028\u0029", - "name": "getRetries", - "summary": "", - "url": "classes/chillerlan-HTTP-CurlMultiHandle.html#method_getRetries" - }, { - "fqsen": "\\chillerlan\\HTTP\\CurlMultiHandle\u003A\u003AsetRetries\u0028\u0029", - "name": "setRetries", - "summary": "", - "url": "classes/chillerlan-HTTP-CurlMultiHandle.html#method_setRetries" - }, { - "fqsen": "\\chillerlan\\HTTP\\CurlMultiHandle\u003A\u003AaddRetry\u0028\u0029", - "name": "addRetry", - "summary": "", - "url": "classes/chillerlan-HTTP-CurlMultiHandle.html#method_addRetry" - }, { - "fqsen": "\\chillerlan\\HTTP\\CurlMultiHandle\u003A\u003AhandleResponse\u0028\u0029", - "name": "handleResponse", - "summary": "", - "url": "classes/chillerlan-HTTP-CurlMultiHandle.html#method_handleResponse" - }, { - "fqsen": "\\chillerlan\\HTTP\\CurlMultiHandle\u003A\u003A\u0024multiResponseHandler", - "name": "multiResponseHandler", - "summary": "", - "url": "classes/chillerlan-HTTP-CurlMultiHandle.html#property_multiResponseHandler" - }, { - "fqsen": "\\chillerlan\\HTTP\\CurlMultiHandle\u003A\u003A\u0024id", - "name": "id", - "summary": "a\u0020handle\u0020ID\u0020\u0028counter\u0029,\u0020used\u0020in\u0020CurlMultiClient", - "url": "classes/chillerlan-HTTP-CurlMultiHandle.html#property_id" - }, { - "fqsen": "\\chillerlan\\HTTP\\CurlMultiHandle\u003A\u003A\u0024retries", - "name": "retries", - "summary": "a\u0020retry\u0020counter,\u0020used\u0020in\u0020CurlMultiClient", - "url": "classes/chillerlan-HTTP-CurlMultiHandle.html#property_retries" }, { "fqsen": "\\chillerlan\\HTTP\\HTTPClientAbstract", "name": "HTTPClientAbstract", @@ -370,26 +330,16 @@ Search.appendIndex( "name": "set_user_agent", "summary": "", "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#method_set_user_agent" - }, { - "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003Aset_ca_info\u0028\u0029", - "name": "set_ca_info", - "summary": "", - "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#method_set_ca_info" }, { "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003Aset_curl_options\u0028\u0029", "name": "set_curl_options", "summary": "", "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#method_set_curl_options" }, { - "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003AsetCA\u0028\u0029", - "name": "setCA", + "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003Aset_dns_over_https\u0028\u0029", + "name": "set_dns_over_https", "summary": "", - "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#method_setCA" - }, { - "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003AcheckCA\u0028\u0029", - "name": "checkCA", - "summary": "Check\u0020whether\u0020the\u0020given\u0020CA\u0020info\u0020exists\u0020and\u0020if\u0020it\u0020is\u0020file\u0020or\u0020dir", - "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#method_checkCA" + "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#method_set_dns_over_https" }, { "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003A\u0024user_agent", "name": "user_agent", @@ -403,7 +353,7 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003A\u0024ca_info", "name": "ca_info", - "summary": "CA\u0020Root\u0020Certificates\u0020for\u0020use\u0020with\u0020CURL\/SSL\u0020\u0028if\u0020not\u0020configured\u0020in\u0020php.ini\u0020or\u0020available\u0020in\u0020a\u0020default\u0020path\u0029", + "summary": "CA\u0020Root\u0020Certificates\u0020for\u0020use\u0020with\u0020CURL\/SSL", "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#property_ca_info" }, { "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003A\u0024ssl_verifypeer", @@ -415,6 +365,11 @@ Search.appendIndex( "name": "curl_multi_options", "summary": "options\u0020for\u0020the\u0020curl\u0020multi\u0020instance", "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#property_curl_multi_options" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003A\u0024curl_check_OCSP", + "name": "curl_check_OCSP", + "summary": "cURL\u0020extra\u0020hardening", + "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#property_curl_check_OCSP" }, { "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003A\u0024window_size", "name": "window_size", @@ -436,10 +391,10 @@ Search.appendIndex( "summary": "Number\u0020of\u0020retries\u0020\u0028multi\u0020fetch\u0029", "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#property_retries" }, { - "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003A\u0024curl_check_OCSP", - "name": "curl_check_OCSP", - "summary": "cURL\u0020extra\u0020hardening", - "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#property_curl_check_OCSP" + "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003A\u0024dns_over_https", + "name": "dns_over_https", + "summary": "Sets\u0020a\u0020DNS\u002Dover\u002DHTTPS\u0020provider\u0020URL", + "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#property_dns_over_https" }, { "fqsen": "\\chillerlan\\HTTP\\LoggingClient", "name": "LoggingClient", @@ -620,6 +575,31 @@ Search.appendIndex( "name": "setUp", "summary": "", "url": "classes/chillerlan-HTTPTest-CurlHandleTest.html#method_setUp" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlHandleTest\u003A\u003AcreateHandle\u0028\u0029", + "name": "createHandle", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlHandleTest.html#method_createHandle" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlHandleTest\u003A\u003AinvalidCaOptionProvider\u0028\u0029", + "name": "invalidCaOptionProvider", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlHandleTest.html#method_invalidCaOptionProvider" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlHandleTest\u003A\u003AtestInvalidCAException\u0028\u0029", + "name": "testInvalidCAException", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlHandleTest.html#method_testInvalidCAException" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlHandleTest\u003A\u003AcaOptionProvider\u0028\u0029", + "name": "caOptionProvider", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlHandleTest.html#method_caOptionProvider" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlHandleTest\u003A\u003AtestCaInfoFile\u0028\u0029", + "name": "testCaInfoFile", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlHandleTest.html#method_testCaInfoFile" }, { "fqsen": "\\chillerlan\\HTTPTest\\CurlHandleTest\u003A\u003ArequestMethodProvider\u0028\u0029", "name": "requestMethodProvider", @@ -805,36 +785,6 @@ Search.appendIndex( "name": "testInvalidUserAgentException", "summary": "", "url": "classes/chillerlan-HTTPTest-HTTPOptionsTest.html#method_testInvalidUserAgentException" - }, { - "fqsen": "\\chillerlan\\HTTPTest\\HTTPOptionsTest\u003A\u003AtestInvalidCAException\u0028\u0029", - "name": "testInvalidCAException", - "summary": "", - "url": "classes/chillerlan-HTTPTest-HTTPOptionsTest.html#method_testInvalidCAException" - }, { - "fqsen": "\\chillerlan\\HTTPTest\\HTTPOptionsTest\u003A\u003AtestCaInfoFile\u0028\u0029", - "name": "testCaInfoFile", - "summary": "", - "url": "classes/chillerlan-HTTPTest-HTTPOptionsTest.html#method_testCaInfoFile" - }, { - "fqsen": "\\chillerlan\\HTTPTest\\HTTPOptionsTest\u003A\u003AtestCaInfoDir\u0028\u0029", - "name": "testCaInfoDir", - "summary": "", - "url": "classes/chillerlan-HTTPTest-HTTPOptionsTest.html#method_testCaInfoDir" - }, { - "fqsen": "\\chillerlan\\HTTPTest\\HTTPOptionsTest\u003A\u003AtestCaInfoInvalidException\u0028\u0029", - "name": "testCaInfoInvalidException", - "summary": "", - "url": "classes/chillerlan-HTTPTest-HTTPOptionsTest.html#method_testCaInfoInvalidException" - }, { - "fqsen": "\\chillerlan\\HTTPTest\\HTTPOptionsTest\u003A\u003AtestCurloptCaInfoInvalidException\u0028\u0029", - "name": "testCurloptCaInfoInvalidException", - "summary": "", - "url": "classes/chillerlan-HTTPTest-HTTPOptionsTest.html#method_testCurloptCaInfoInvalidException" - }, { - "fqsen": "\\chillerlan\\HTTPTest\\HTTPOptionsTest\u003A\u003AtestSetVerifyPeer\u0028\u0029", - "name": "testSetVerifyPeer", - "summary": "", - "url": "classes/chillerlan-HTTPTest-HTTPOptionsTest.html#method_testSetVerifyPeer" }, { "fqsen": "\\chillerlan\\HTTPTest\\LoggingClientTest", "name": "LoggingClientTest", diff --git a/namespaces/chillerlan-http.html b/namespaces/chillerlan-http.html index dbd06fee..478a18ea 100644 --- a/namespaces/chillerlan-http.html +++ b/namespaces/chillerlan-http.html @@ -124,7 +124,7 @@

          -
          ClientException
          CurlClient
          A simple cURL http client
          CurlHandle
          Implements a cURL connection object
          CurlMultiClient
          Curl multi http client
          CurlMultiHandle
          Implements a cURL multi connection object
          HTTPClientAbstract
          HTTPOptions
          LoggingClient
          a silly logging wrapper (do not use in production!)
          NetworkException
          RequestException
          StreamClient
          URLExtractor
          A client that follows redirects until it reaches a non-30x response, e.g. to extract shortened URLs
          +
          ClientException
          CurlClient
          A simple cURL http client
          CurlHandle
          Implements a cURL connection object
          CurlMultiClient
          Curl multi http client
          HTTPClientAbstract
          HTTPOptions
          LoggingClient
          a silly logging wrapper (do not use in production!)
          NetworkException
          RequestException
          StreamClient
          URLExtractor
          A client that follows redirects until it reaches a non-30x response, e.g. to extract shortened URLs

          Traits diff --git a/packages/Application.html b/packages/Application.html index 2029f4ee..11803d60 100644 --- a/packages/Application.html +++ b/packages/Application.html @@ -123,7 +123,7 @@

          -
          ClientException
          CurlClient
          A simple cURL http client
          CurlHandle
          Implements a cURL connection object
          CurlMultiClient
          Curl multi http client
          CurlMultiHandle
          Implements a cURL multi connection object
          HTTPClientAbstract
          HTTPOptions
          LoggingClient
          a silly logging wrapper (do not use in production!)
          NetworkException
          RequestException
          StreamClient
          URLExtractor
          A client that follows redirects until it reaches a non-30x response, e.g. to extract shortened URLs
          CurlClientNoCATest
          CurlClientTest
          CurlHandleTest
          CurlMultiClientTest
          HTTPClientTestAbstract
          HTTPOptionsTest
          LoggingClientTest
          StreamClientNoCATest
          StreamClientTest
          URLExtractorTest
          +
          ClientException
          CurlClient
          A simple cURL http client
          CurlHandle
          Implements a cURL connection object
          CurlMultiClient
          Curl multi http client
          HTTPClientAbstract
          HTTPOptions
          LoggingClient
          a silly logging wrapper (do not use in production!)
          NetworkException
          RequestException
          StreamClient
          URLExtractor
          A client that follows redirects until it reaches a non-30x response, e.g. to extract shortened URLs
          CurlClientNoCATest
          CurlClientTest
          CurlHandleTest
          CurlMultiClientTest
          HTTPClientTestAbstract
          HTTPOptionsTest
          LoggingClientTest
          StreamClientNoCATest
          StreamClientTest
          URLExtractorTest

          Traits diff --git a/reports/markers.html b/reports/markers.html index bf834508..bae5dea2 100644 --- a/reports/markers.html +++ b/reports/markers.html @@ -123,7 +123,7 @@

          CurlMultiClientTest.php TODO - 104 + 106