masterklavi/phprequest

PHP Request

PHP Request

It includes some functions to easy requesting and parsing data., _(*1)

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:, _(*2)

$ composer require masterklavi/phprequest

Include vendor/autoload.php:, _(*3)

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:, _(*4)

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

or download the package at https://github.com/masterklavi/phprequest/archive/master.zip, _(*5)

Include autoload.php:, _(*6)

<?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., _(*7)

Syntax

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

Parameters

$url – URL address
$options – Array of request options, _(*8)

Return Values

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

Request::get

Alias of Request::request(), _(*10)

Request::post

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

Request::multi

Requests the given URLs (parallel requests using curl multi)., _(*12)

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, _(*13)

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, _(*14)

Request::multiGet

Alias of Request::multi(), _(*15)

Request::multiPost

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

Request Options

List of curl options:, _(*17)

List of special options:, _(*18)

Filters

Plain filters:, _(*19)

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:, _(*20)

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

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

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

  where $options is key-value array that may contains:, _(*22)

  • '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:, _(*23)

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

  Returns null if the pattern doesn't match the body, or false if an error occured, _(*24)

• regex_one - returns the first matched text (uses preg_match), _(*25)
• 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)