masterklavi/phprequest

There is no license information available for the latest version (v0.3.6) of this package.

PHP Request

v0.3.6 2017-06-07 17:08 UTC

Requires

• php: >=5.4.0
• ext-curl: *

Unknown License

• Master Klavi

README

It includes some functions to easy requesting and parsing data.

Examples

use \phprequest\Request;

print Request::request('https://api.ipify.org/'); // prints your IP address received from https://api.ipify.org/
print PHP_EOL;

print Request::get('https://api.ipify.org?format=json', ['filter' => 'json'])->ip . PHP_EOL;
print Request::get('https://api.ipify.org?format=json', ['filter' => 'json_assoc'])['ip'] . PHP_EOL;

// Request::post('http://example.com', ['data' => ['name' => 'John']]);

// Request::multi(['http://example.com', 'http://example.com/1', 'http://example.com/2'], ['concurrency' => 2]);
// Request::multiPost(['http://example.com', ['http://example.com/1', ['filter' => 'json']], 'http://example.com/2'], ['concurrency' => 2]);

Requirements

• PHP version 5.4.0 or higher
• PHP extension ext-curl enabled

Installation

Using Composer

Get the package:

$ composer require masterklavi/phprequest

Include vendor/autoload.php:

include 'vendor/autoload.php';
use \phprequest\Request;

$data = Request::get('http://www.cbr-xml-daily.ru/daily_json.js', ['filter' => 'json']);
print 'USD: ' . $data->Valute->USD->Value, PHP_EOL;

Manual Installation

Clone git repository:

$ git clone https://github.com/masterklavi/phprequest.git

or download the package at https://github.com/masterklavi/phprequest/archive/master.zip

Include autoload.php:

<?php
include 'autoload.php';
use \phprequest\Request;

$data = Request::get('http://www.cbr-xml-daily.ru/daily_json.js', ['filter' => 'json']);
print 'USD: ' . $data->Valute->USD->Value, PHP_EOL;

Methods

Request::request

Requests the given URL.

Syntax

mixed Request::request(string $url, array $options = [])

Parameters

$url – URL address
$options – Array of request options

Return Values

Returns a response (body) as string by default. Returns a mixed value when the filter option's set. Returns false on failure.

Request::get

Alias of Request::request()

Request::post

Equivalent of Request::request($url, ['method' => 'POST'])

Request::multi

Requests the given URLs (parallel requests using curl multi).

Syntax

mixed Request::multi(string $urls, array $options = [])

Parameters

$url – Array of URL address strings or arrays of URL addresses and their options (e.g. [ 'http://a.ru', ['http://b.ru', ['filter' => 'json']] ])
$options – Array of request options

Return Values

Returns an array of results for the given urls. Result may contain:

• a response (body) as string by default
• a mixed value when the filter option's set
• false on failure

Request::multiGet

Alias of Request::multi()

Request::multiPost

Equivalent of Request::multi($urls, ['method' => 'POST'])

Request Options

List of curl options:

Name	Type	Default	Description
method	string	GET	The method of the HTTP request (GET, POST, HEAD, PUT, DELETE) (see CURLOPT_POST, CURLOPT_CUSTOMREQUEST)
data	string, array		Querystring for GET, HEAD and DELETE requests, or request body for others (see CURLOPT_POSTFIELDS)
follow	boolean	false	Follow HTTP redirections (see CURLOPT_FOLLOWLOCATION)
encoding	string		The contents of the "Accept-Encoding: " header (see CURLOPT_ENCODING)
timeout	integer	300	The timeout of one request (see CURLOPT_TIMEOUT)
session	string		Path to cookie-based session file (enables session between different calls) (see CURLOPT_COOKIEJAR)
cookie	string		The contents of the "Cookie: " header (see CURLOPT_COOKIE)
headers	array		An array of HTTP headers (see CURLOPT_HTTPHEADER)
referer	string		The contents of the "Referer: " header (see CURLOPT_REFERER)
useragent	string		The contents of the "User-Agent: " header (see CURLOPT_USERAGENT)
proxy	string		Proxy string like IP:PORT or username:password@IP:PORT (see CURLOPT_PROXY, CURLOPT_PROXYUSERPWD)
interface	string		Used interface (IP or host) (see CURLOPT_INTERFACE)
curl	array		An array of custom curl options

List of special options:

Name	Type	Default	Description
allowed_codes	array	[200]	Allowed HTTP codes
allow_empty	boolean	false	Allows empty body of the HTTP response
filter	string, callable		Filters body (usually to reduce memory usage). See Available filters
charset	string		The charset of requested content (the result will contain 'utf8')
attempts	integer	5	Number of request attempts
concurrency	integer	10	Concurrency of requests in Request::multi()

Filters

Plain filters:

Request::get($url, ['filter' => 'json']);

• json - interprets the body as json and returns an object
• json_assoc - interprets the body as json and returns an associative array
• xml - interprets the body as xml and returns SimpleXML objects
• plain - returns full response (with headers) as plain text
• headers - returns a set of the headers
• headers_body - returns a set of the headers and the body as plain text

Complex filters:

Request::get($url, ['filter' => ['filter_name', $option]])

• cut - cuts out a new substring using begin and end substrings (tags)
  Syntax:

  Request::get($url, ['filter' => ['cut', $options]])

  where $options is key-value array that may contains:

  • 'begin' => 'some string' - substring as beginning of the cut
  • 'end' => 'some string' - substring as ending of the cut
  • 'case_sensivity' => true - use begin and end as case sensivity substrings
  • 'mbstring' => true - use mb_* functions on cutting

• regex - returns an array of the results matched the regular expression (uses preg_match)
  Syntax:

  Request::get($url, ['filter' => ['cut', '#reg.exp. pattern#']])

  Returns null if the pattern doesn't match the body, or false if an error occured

• regex_one - returns the first matched text (uses preg_match)

• regex_all - returns an array of arrays of the results of search used the regular expression (uses preg_match_all)

• regex_set - returns an array of arrays of the results of search used the regular expression (uses preg_match_all with the set order)

• regex_col - returns an array of the results of the first values matched the regular expression (uses preg_match_all)