Sledgehammer Framework

Curl extends Base

in package

• Application

Uses EventEmitter

Curl, an HTTP/FTP response object Simplifies asynchronous requests & paralell downloads.

Table of Contents

$connect_time  : mixed

$content_length_download  : mixed

$content_length_upload  : mixed

$content_type  : mixed

$defaults  : array<string|int, mixed>

Sane defaults for Curl requests. Only used in the static helper methods like Curl::get(), Curl::post(), etc.

$effective_url  : string

$filetime  : mixed

$header_out  : mixed

$header_size  : mixed

$http_code  : string

$keepalive  : bool

Keep the connections open, speeds up requests to the same server.

$maxConcurrent  : int

The maximum number of concurrent downloads.

$namelookup_time  : mixed

$onAbort  : Closure

$onLoad  : Closure

$pretransfer_time  : mixed

$redirect_time  : mixed

$request_size  : mixed

$requests  : array<string|int, Curl>

Global queue of active cURL requests.

$size_download  : mixed

$size_upload  : mixed

$speed_download  : mixed

$speed_upload  : mixed

$ssl_verifyresult  : mixed

$starttransfer_time  : mixed

$total_time  : mixed

$events  : array<string|int, mixed>

Allow listening to the events: 'load' and 'abort'.

$__kvo  : array<string|int, mixed>

Storage array for the properties with KVO (Key Value Observer) listeners.

$handle  : resource

cURL handle.

$options  : array<string|int, mixed>

All the given CURLOPT_* options.

$pool  : resource

cURL multi handle.

$state  : string

RUNNING | COMPLETED | ABORTED | ERROR.

$tranferCount  : int

Number of tranfers in the pool.

__call()  : mixed

Report that the $method doesn't exist.

__callStatic()  : mixed

Report that the $method doesn't exist.

__construct()  : mixed

Create a new cURL request/response.

__destruct()  : mixed

Complete the transfer and remove the curl handle from the pool.

__get()  : mixed

Access CURLINFO_* info as properties.

__set()  : mixed

Report that $property doesn't exist and set the property to the given $value.

__toString()  : string

Returns the response body.

abort()  : mixed

Abort the current request/download.

delete()  : Curl

Preform an asynchonous DELETE request.

download()  : Curl

Download a file to the filesystem.

file()  : CURLFile

Create a file value for use in CURLOPT_POSTFIELDS.

get()  : Curl

Preform an asynchonous GET request.

getBody()  : string

Return the response body.

getContent()  : string

The response body.

getHeader()  : string|null

Get the value of a specific response header.

getHeaders()  : array<string|int, mixed>

Get all response headers.

getInfo()  : mixed

Get information about the response.

hasEvent()  : bool

Check id the $event is a registered event.

isComplete()  : bool

Check if this request is complete.

off()  : mixed

Remove a callback from an event.

on()  : string

Add a callback for an event.

post()  : Curl

Preform an asynchonous POST request.

proxy()  : mixed

Proxy/resend the current request to different url/server.

put()  : Curl

Preform an asynchonous PUT request.

putFile()  : Curl

Preform an asynchonous PUT request.

resend()  : mixed

Reuse the curl handle/connection to (re)send an request Use the options to override settings from the previous request.

synchronize()  : mixed

Wait for all requests to complete.

trigger()  : mixed

Trigger an event.

waitForCompletion()  : mixed

Wait for the request to complete.

defaults()  : array<string|int, mixed>

Merge options with the default options.

errorName()  : string

Convert a CURLE_* integer to the constantname.

multiErrorName()  : string

Convert a CURLM_* integer to the constantname.

optionName()  : string

Convert a CURLOPT_* integer to the constantname.

start()  : mixed

Start the request 1. Set the CURLOPT_* options 2. Add the request to the pool 3. Starts the request.

stop()  : mixed

Remove the request from the pool.

throttle()  : mixed

Limit the number of active transfers.