Documentation

Connector
in package

Table of Contents

Properties

$error  : mixed
$headerOnly  : mixed
$headers  : mixed
$method  : mixed
$proxy  : mixed
$proxyAuth  : mixed
$proxyEnabled  : mixed
$proxyUrl  : mixed
$query  : mixed
$client  : mixed

Methods

__construct()  : mixed
addHeader()  : mixed
Sets value in the header
addQuery()  : mixed
Adds to the query string
execute()  : mixed
Performs the request to the url
extractQueryString()  : mixed
Extracts query string data into an associative array
getResponseHeaders()  : mixed
Formats the response headers from guzzle into standard string
getResult()  : mixed
Returns the result that has already been executed.
isProxyEnabled()  : mixed
Determines if proxy is enabled
setError()  : mixed
Sets an error message for the request
setMethod()  : mixed
Determines the method used to connect
setReferer()  : mixed
Sets the referer in the request
setUserAgent()  : mixed
Sets the user agent for the request
useHeadersOnly()  : mixed
Determins if we should only be requesting for head data only

Properties

$headerOnly

protected mixed $headerOnly = false

$proxyEnabled

protected mixed $proxyEnabled = null

Methods

__construct()

public __construct([mixed $url = '' ]) : mixed
Parameters
$url : mixed = ''

addHeader()

Sets value in the header

public addHeader(mixed $key, mixed $value) : mixed
Parameters
$key : mixed
$value : mixed
Tags
since
1.0.0
access

public

addQuery()

Adds to the query string

public addQuery(mixed $key, mixed $value) : mixed
Parameters
$key : mixed
$value : mixed
Tags
since
1.0.0
access

public

execute()

Performs the request to the url

public execute() : mixed
Tags
since
1.0.0
access

public

extractQueryString()

Extracts query string data into an associative array

public extractQueryString(mixed $url) : mixed
Parameters
$url : mixed
Tags
since
1.0.0
access

public

getResponseHeaders()

Formats the response headers from guzzle into standard string

public getResponseHeaders() : mixed
Tags
since
1.0.0
access

public

getResult()

Returns the result that has already been executed.

public getResult([mixed $withHeaders = false ]) : mixed
Parameters
$withHeaders : mixed = false
Tags
since
1.0.0
access

public

isProxyEnabled()

Determines if proxy is enabled

public isProxyEnabled() : mixed
Tags
since
1.0.0
access

public

setError()

Sets an error message for the request

public setError(mixed $message) : mixed
Parameters
$message : mixed
Tags
since
1.0.0
access

public

setMethod()

Determines the method used to connect

public setMethod([mixed $method = 'GET' ]) : mixed
Parameters
$method : mixed = 'GET'
Tags
since
1.0.0
access

public

setReferer()

Sets the referer in the request

public setReferer(mixed $referer) : mixed
Parameters
$referer : mixed
Tags
since
1.0.0
access

public

setUserAgent()

Sets the user agent for the request

public setUserAgent(mixed $userAgent) : mixed
Parameters
$userAgent : mixed
Tags
since
1.0.0
access

public

useHeadersOnly()

Determins if we should only be requesting for head data only

public useHeadersOnly() : mixed
Tags
since
1.0.0
access

public


        
On this page

Search results