WebFetchApi
in package
implements
WebFetchApiInterface
Class SearchApi
Table of Contents
Interfaces
Properties
- $current_redirect : int
- $response : array<string|int, mixed>
- $scheme_handlers : array<string|int, mixed>
- $still_alive : array<string|int, mixed>
Methods
- fetch() : string|false
- Get the contents of a URL, irrespective of allow_url_fopen.
- request() : object
- Main calling function.
- result() : mixed
- Used to return the results to the caller.
- resultRaw() : array<string|int, mixed>
- Will return all results from all loops (redirects)
- buildPostData() : string
- Takes supplied POST data and urlencodes it.
Properties
$current_redirect
public
int
$current_redirect
= 0
How many redirects have been followed.
$response
public
array<string|int, mixed>
$response
= []
Stores responses (url, code, error, headers, body, size).
$scheme_handlers
public
static array<string|int, mixed>
$scheme_handlers
= ['ftp' => ['FtpFetcher'], 'ftps' => ['FtpFetcher'], 'http' => ['SocketFetcher', 'CurlFetcher'], 'https' => ['SocketFetcher', 'CurlFetcher']]
Specifies the fetcher class or classes to try for any given URL scheme.
Keys are URL schemes. Values are the names of one or more classes to try.
Class names will be prepended with NAMESPACE . '\APIs'.
$still_alive
private
static array<string|int, mixed>
$still_alive
= []
Fetchers that still have an open connection after the initial request.
Methods
fetch()
Get the contents of a URL, irrespective of allow_url_fopen.
public
static fetch(Url|string $url[, string|array<string|int, mixed> $post_data = [] ][, bool $keep_alive = false ]) : string|false
- Reads the contents of an HTTP or FTP address and returns those contents in a string.
- If $post_data is supplied, the value and length is posted to the given URL as form data.
Parameters
- $url : Url|string
-
An HTTP or FTP URL.
- $post_data : string|array<string|int, mixed> = []
-
The data to post to the given URL. Not applicable to FTP requests.
- $keep_alive : bool = false
-
Whether to keep the connection alive for further requests. Not applicable to FTP requests.
Return values
string|false —The fetched data or false on failure.
request()
Main calling function.
public
request(string $url[, array<string|int, mixed>|string $post_data = [] ]) : object
Parameters
- $url : string
-
the site we are going to fetch
- $post_data : array<string|int, mixed>|string = []
-
any post data as form name => value
Return values
object —A reference to the object for method chaining.
result()
Used to return the results to the caller.
public
result([string|null $area = null ]) : mixed
Parameters
- $area : string|null = null
-
Used to return an area such as body, header, error.
Return values
mixed —The response.
resultRaw()
Will return all results from all loops (redirects)
public
resultRaw([int|null $response_number = null ]) : array<string|int, mixed>
Parameters
- $response_number : int|null = null
-
Which response to get, or null for all.
Return values
array<string|int, mixed> —The specified response or all the responses.
buildPostData()
Takes supplied POST data and urlencodes it.
protected
buildPostData(array<string|int, mixed>|string $post_data) : string
- Forms the data (for POST) into a string like var=xyz&var2=abc&var3=123
- Drops vars with @ since we don't support sending files (uploading)
Parameters
- $post_data : array<string|int, mixed>|string
-
The raw POST data.
Return values
string —A string of POST data.