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
$error
protected
mixed
$error
= ''
$headerOnly
protected
mixed
$headerOnly
= false
$headers
protected
mixed
$headers
= []
$method
protected
mixed
$method
= 'GET'
$proxy
protected
mixed
$proxy
= null
$proxyAuth
protected
mixed
$proxyAuth
= ''
$proxyEnabled
protected
mixed
$proxyEnabled
= null
$proxyUrl
protected
mixed
$proxyUrl
= ''
$query
protected
mixed
$query
= []
$client
private
mixed
$client
= 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
addQuery()
Adds to the query string
public
addQuery(mixed $key, mixed $value) : mixed
Parameters
- $key : mixed
- $value : mixed
Tags
execute()
Performs the request to the url
public
execute() : mixed
Tags
extractQueryString()
Extracts query string data into an associative array
public
extractQueryString(mixed $url) : mixed
Parameters
- $url : mixed
Tags
getResponseHeaders()
Formats the response headers from guzzle into standard string
public
getResponseHeaders() : mixed
Tags
getResult()
Returns the result that has already been executed.
public
getResult([mixed $withHeaders = false ]) : mixed
Parameters
- $withHeaders : mixed = false
Tags
isProxyEnabled()
Determines if proxy is enabled
public
isProxyEnabled() : mixed
Tags
setError()
Sets an error message for the request
public
setError(mixed $message) : mixed
Parameters
- $message : mixed
Tags
setMethod()
Determines the method used to connect
public
setMethod([mixed $method = 'GET' ]) : mixed
Parameters
- $method : mixed = 'GET'
Tags
setReferer()
Sets the referer in the request
public
setReferer(mixed $referer) : mixed
Parameters
- $referer : mixed
Tags
setUserAgent()
Sets the user agent for the request
public
setUserAgent(mixed $userAgent) : mixed
Parameters
- $userAgent : mixed
Tags
useHeadersOnly()
Determins if we should only be requesting for head data only
public
useHeadersOnly() : mixed