Download the PHP package bayfrontmedia/multi-curl without Composer
On this page you can find all versions of the php package bayfrontmedia/multi-curl. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download bayfrontmedia/multi-curl
More information about bayfrontmedia/multi-curl
Files in bayfrontmedia/multi-curl
Package multi-curl
Short Description A simple HTTP client to make single or asynchronous requests utilizing the cURL library.
License MIT
Homepage https://github.com/bayfrontmedia/multi-curl
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package multi-curl
Multi cURL
A simple HTTP client to make single or asynchronous requests utilizing the cURL library.
- License
- Author
- Requirements
- Installation
- Usage
License
This project is open source and available under the MIT License.
Author
Requirements
- PHP
^8.0 - cURL PHP extension
- JSON PHP extension
Installation
Usage
Single HTTP request
A base URL can be set so that future request-related methods do not have to specify the full endpoint. For example:
The cURL handle will be created automatically and be ready to use.
Asynchronous HTTP requests
Multiple HTTP requests can be made simultaneously instead of one after the other, thereby limiting the completion time to the duration of the single slowest request instead of the sum of all requests combined.
A base URL can be set so that future request-related methods do not have to specify the full endpoint. For example:
cURL handles must be made explicitly using the create() method before using.
Public methods
Async class only
- create
- use
- execute
Once a cURL handle has been created, the following methods can be used:
- getHandle
- reset
- close
- setOptions
- setHeaders
- setToken
Request
- download
- get
- connect
- delete
- head
- options
- patch
- post
- put
- trace
Response
- getHeaders
- getHeader
- getBody
- getErrorNumber
- isError
- getErrorMessage
- getStatusCode
- getInfo
- isInformational
- isSuccessful
- isRedirection
- isClientError
- isServerError
- isOk
- isForbidden
- isNotFound
create
Description:
(Only available in Async class)
Create cURL handles with identifiers.
cURL handles must be created before they can be used.
Parameters:
$ids(array)
Returns:
- (self)
Example:
use
Description:
(Only available in Async class)
Sets current cURL handle.
Once the cURL handle has been created using create(), it can be used by specifying the ID of the handle you wish to use.
A Bayfront\MultiCurl\ClientException exception will be thrown if the ID does not exist.
Parameters:
$id(string)
Returns:
- (self)
Throws:
Bayfront\MultiCurl\ClientException
Example:
execute
Description:
(Only available in Async class)
Execute the given cURL session.
The response methods will only return results after the execute() method has been called.
Parameters:
- None
Returns:
- (self)
Example:
See the above example for use().
getHandle
Description:
Returns the cURL handle.
A Bayfront\MultiCurl\ClientException exception will be thrown if the handle does not exist.
Parameters:
- None
Returns:
- (resource): cURL handle
Throws:
Bayfront\MultiCurl\ClientException
reset
Description:
Resets all request settings.
Parameters:
- None
Returns:
- (self)
close
Description:
Reset all settings and close the cURL handle(s).
NOTE: This method is called in the class destructor.
Parameters:
- None
Returns:
- (self)
setOptions
Description:
Sets an array of options for the cURL session.
Parameters:
$options(array)
Returns:
- (self)
Example:
setHeaders
Description:
Sets an array of headers for the cURL session.
Parameters:
$headers(array)
Returns:
- (self)
Example:
setToken
Description:
Sets token authorization header using a given token.
Parameters:
$token(string)
Returns:
- (self)
download
Description:
(Only available in Client class)
Initiates file download in the browser.
Parameters:
$url(string)
Returns:
- (void)
Example:
get
Description:
Executes GET request, including optional data sent as query parameters.
Parameters:
$url(string)$data = [](array)
Returns:
- (self)
Example:
connect
Description:
Executes CONNECT request, including optional data.
Parameters:
$url(string)$data = [](array)$json_encode = false(bool): json_encode the$dataarray and set theContent-Typeheader asapplication/json, if not already defined
Returns:
- (self)
delete
Description:
Executes DELETE request, including optional data.
Parameters:
$url(string)$data = [](array)$json_encode = false(bool): json_encode the$dataarray and set theContent-Typeheader asapplication/json, if not already defined
Returns:
- (self)
head
Description:
Executes HEAD request, including optional data.
Parameters:
$url(string)$data = [](array)$json_encode = false(bool): json_encode the$dataarray and set theContent-Typeheader asapplication/json, if not already defined
Returns:
- (self)
options
Description:
Executes OPTIONS request, including optional data.
Parameters:
$url(string)$data = [](array)$json_encode = false(bool): json_encode the$dataarray and set theContent-Typeheader asapplication/json, if not already defined
Returns:
- (self)
patch
Description:
Executes PATCH request, including optional data.
Parameters:
$url(string)$data = [](array)$json_encode = false(bool): json_encode the$dataarray and set theContent-Typeheader asapplication/json, if not already defined
Returns:
- (self)
post
Description:
Executes POST request, including optional data.
Parameters:
$url(string)$data = [](array)$json_encode = false(bool): json_encode the$dataarray and set theContent-Typeheader asapplication/json, if not already defined
Returns:
- (self)
put
Description:
Executes PUT request, including optional data.
Parameters:
$url(string)$data = [](array)$json_encode = false(bool): json_encode the$dataarray and set theContent-Typeheader asapplication/json, if not already defined
Returns:
- (self)
trace
Description:
Executes TRACE request, including optional data.
Parameters:
$url(string)$data = [](array)$json_encode = false(bool): json_encode the$dataarray and set theContent-Typeheader asapplication/json, if not already defined
Returns:
- (self)
getHeaders
Description:
Returns array of headers from the previous request.
Parameters:
- None
Returns:
- (array)
Example:
getHeader
Description:
Returns single header value from the previous request, with optional default value if not existing.
Parameters:
$header(string)$default = NULL(mixed)
Returns:
- (mixed)
Example:
getBody
Description:
Returns body of the previous request, with optional default value if not existing.
Parameters:
$json_decode = false(bool): Decode JSON contents to an array$default = NULL(mixed)
Returns:
- (mixed)
Example:
getErrorNumber
Description:
Returns error number of the previous request, or zero if no error exists.
Parameters:
- None
Returns:
- (int)
Example:
isError
Description:
Is previous request an error.
Parameters:
- None
Returns:
- (bool)
getErrorMessage
Description:
Returns error message of the previous request, or an empty string if no error occurred.
Parameters:
- None
Returns:
- (string)
getStatusCode
Description:
Returns status code of the previous request, or zero if not existing.
Parameters:
- None
Returns:
- (int)
getInfo
Description:
Returns array of information about the previous request, a single option constant, or null if not existing.
Parameters:
$opt = NULL(mixed): Optional option constant
For more information, see: curl_getinfo
Returns:
- (mixed)
isInformational
Description:
Is status code informational.
Parameters:
- None
Returns:
- (bool)
isSuccessful
Description:
Is status code successful.
Parameters:
- None
Returns:
- (bool)
isRedirection
Description:
Is status code a redirection.
Parameters:
- None
Returns:
- (bool)
isClientError
Description:
Is status code a client error.
Parameters:
- None
Returns:
- (bool)
isServerError
Description:
Is status code a server error.
Parameters:
- None
Returns:
- (bool)
isOk
Description:
Is status code OK (200).
Parameters:
- None
Returns:
- (bool)
isForbidden
Description:
Is status code forbidden (403).
Parameters:
- None
Returns:
- (bool)
isNotFound
Description:
Is status code not found (404).
Parameters:
- None
Returns:
- (bool)
All versions of multi-curl with dependencies
ext-curl Version *
ext-json Version *
bayfrontmedia/php-array-helpers Version ^2.0
bayfrontmedia/php-mime-types Version ^2.0