Class Stream
Implements sending Cake\Http\Client\Request via php's stream API.
This approach and implementation is partly inspired by Aura.Http
Property Summary
-
$_connectionErrors protected
arrayConnection error list.
-
$_context protected
resource|nullContext resource used by the stream API.
-
$_contextOptions protected
arrayArray of options/content for the HTTP stream context.
-
$_sslContextOptions protected
arrayArray of options/content for the SSL stream context.
-
$_stream protected
resource|nullThe stream resource.
Method Summary
-
_buildContent() protected
Builds the request content based on the request object.
-
_buildContext() protected
Build the stream context out of the request object.
-
_buildHeaders() protected
Build the header context for the request.
-
_buildOptions() protected
Build miscellaneous options for the request.
-
_buildResponse() protected
Build a response object
-
_buildSslContext() protected
Build SSL options for the request.
-
_open() protected
Open the socket and handle any connection errors.
-
_send() protected
Open the stream and send the request.
-
contextOptions() public
Get the context options
-
createResponses() public
Create the response list based on the headers & content
-
send() public
Send a request and get a response back.
Method Detail
_buildContent() ¶ protected
_buildContent(Psr\Http\Message\RequestInterface $request, array<string, mixed> $options): voidBuilds the request content based on the request object.
If the $request->body() is a string, it will be used as is. Array data will be processed with {@link \Cake\Http\Client\FormData}
Parameters
-
Psr\Http\Message\RequestInterface$request The request being sent.
-
array<string, mixed>$options Array of options to use.
Returns
void_buildContext() ¶ protected
_buildContext(Psr\Http\Message\RequestInterface $request, array<string, mixed> $options): voidBuild the stream context out of the request object.
Parameters
-
Psr\Http\Message\RequestInterface$request The request to build context from.
-
array<string, mixed>$options Additional request options.
Returns
void_buildHeaders() ¶ protected
_buildHeaders(Psr\Http\Message\RequestInterface $request, array<string, mixed> $options): voidBuild the header context for the request.
Creates cookies & headers.
Parameters
-
Psr\Http\Message\RequestInterface$request The request being sent.
-
array<string, mixed>$options Array of options to use.
Returns
void_buildOptions() ¶ protected
_buildOptions(Psr\Http\Message\RequestInterface $request, array<string, mixed> $options): voidBuild miscellaneous options for the request.
Parameters
-
Psr\Http\Message\RequestInterface$request The request being sent.
-
array<string, mixed>$options Array of options to use.
Returns
void_buildResponse() ¶ protected
_buildResponse(array $headers, string $body): Cake\Http\Client\ResponseBuild a response object
Parameters
-
array$headers Unparsed headers.
-
string$body The response body.
Returns
Cake\Http\Client\Response_buildSslContext() ¶ protected
_buildSslContext(Psr\Http\Message\RequestInterface $request, array<string, mixed> $options): voidBuild SSL options for the request.
Parameters
-
Psr\Http\Message\RequestInterface$request The request being sent.
-
array<string, mixed>$options Array of options to use.
Returns
void_open() ¶ protected
_open(string $url, Psr\Http\Message\RequestInterface $request): voidOpen the socket and handle any connection errors.
Parameters
-
string$url The url to connect to.
-
Psr\Http\Message\RequestInterface$request The request object.
Returns
voidThrows
Psr\Http\Client\RequestExceptionInterface_send() ¶ protected
_send(Psr\Http\Message\RequestInterface $request): arrayOpen the stream and send the request.
Parameters
-
Psr\Http\Message\RequestInterface$request The request object.
Returns
arrayThrows
Psr\Http\Client\NetworkExceptionInterfacecontextOptions() ¶ public
contextOptions(): arrayGet the context options
Useful for debugging and testing context creation.
Returns
arraycreateResponses() ¶ public
createResponses(array $headers, string $content): array<Cake\Http\Client\Response>Create the response list based on the headers & content
Creates one or many response objects based on the number of redirects that occurred.
Parameters
-
array$headers The list of headers from the request(s)
-
string$content The response content.
Returns
array<Cake\Http\Client\Response>send() ¶ public
send(Psr\Http\Message\RequestInterface $request, array<string, mixed> $options): array<Cake\Http\Client\Response>Send a request and get a response back.
Parameters
-
Psr\Http\Message\RequestInterface$request -
array<string, mixed>$options
Returns
array<Cake\Http\Client\Response>