CurlHelper

A trait for using cURL

trait CurlHelper
Copyright
2015-2016 Appertly
License
Apache-2.0

Instance Methods

Protected
ReturnsSignature and Description
Awaitable<string>
exec(mixed $urlOrHandle)

A convenience wrapper aroundcurl_multi_await.

string
getUserAgent()

Gets a User-Agent string.

Awaitable<string>
send(RequestInterface $request)

Does a decent job of sending off a PSR-7 request using cURL

Method Details

exec

protected function exec(mixed $urlOrHandle)

A convenience wrapper aroundcurl_multi_await.

Pass a cURL handle, or, more simply, a string containing a URL (and the cURL handle will be created for you), and the cURL request will be executed via async and the string result will be retuned.

Parameters
NameTypeDescription
$urlOrHandleresource | string
  • An existing cURL handle or a string URL. String URLs will create a default cURL GET handle.
Returns
TypeDescription
Awaitable<string>

An Awaitable representing the string result of the cURL request.

Throws
TypeConditions
Unreachable

if the remote server cannot be reached

Misconfigured

if cURL was incorrectly configured

Unexpected

if the remote server returned an error

getUserAgent

protected function getUserAgent()

Gets a User-Agent string.

Returns
TypeDescription
string

a reasonable user-agent string

send

protected function send(RequestInterface $request)

Does a decent job of sending off a PSR-7 request using cURL

Parameters
NameTypeDescription
$requestRequestInterface

The request

Returns
TypeDescription
Awaitable<string>

The async response

Throws
TypeConditions
Unreachable

if the remote server cannot be reached

Misconfigured

if cURL was incorrectly configured

Unexpected

if the remote server returned an error