Skip to content

Commit 960cefc

Browse files
phpdevcommunityphpdevcommunity
committed
Implement basic HTTP client with GET and POST methods, including support for JSON and form-encoded data. Added helper functions for simplified usage
0 parents  commit 960cefc

10 files changed

+800
-0
lines changed

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/.idea/
2+
/vendor/

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 PhpDevCommunity
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+156
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
# PHP Http Client
2+
3+
This PHP HTTP Client provides a minimalistic way to perform `GET` and `POST` HTTP requests with customizable headers. It allows you to handle JSON data, form-encoded requests, and more, without using cURL.
4+
5+
## Installation
6+
7+
You can install this library via [Composer](https://getcomposer.org/). Ensure your project meets the minimum PHP version requirement of 7.4.
8+
9+
```bash
10+
composer require phpdevcommunity/php-httpclient
11+
```
12+
## Requirements
13+
14+
- PHP version 7.4 or higher
15+
16+
## Features
17+
18+
- Supports `GET` and `POST` requests.
19+
- Customize headers for each request.
20+
- Automatically handles JSON or form-encoded data.
21+
- Easily configurable base URL for all requests.
22+
- Includes error handling for invalid URLs and timeouts.
23+
24+
## Usage
25+
26+
### Basic GET Request
27+
28+
```php
29+
use PhpDevCommunity\HttpClient\HttpClient;
30+
31+
$client = new HttpClient(['base_url' => 'http://example.com']);
32+
33+
// Perform a GET request
34+
$response = $client->get('/api/data');
35+
36+
if ($response->getStatusCode() === 200) {
37+
echo $response->getBody(); // Raw response body
38+
print_r($response->bodyToArray()); // JSON decoded response
39+
}
40+
```
41+
42+
### GET Request with Query Parameters
43+
44+
```php
45+
$response = $client->get('/api/search', ['query' => 'test']);
46+
```
47+
48+
### POST Request (Form-Encoded)
49+
50+
```php
51+
$data = [
52+
'username' => 'testuser',
53+
'password' => 'secret'
54+
];
55+
56+
$response = $client->post('/api/login', $data);
57+
```
58+
59+
### POST Request (JSON)
60+
61+
```php
62+
$data = [
63+
'title' => 'Hello World',
64+
'content' => 'This is a post content'
65+
];
66+
67+
$response = $client->post('/api/posts', $data, true); // `true` specifies JSON content type
68+
```
69+
70+
### Custom Headers
71+
72+
```php
73+
$client = new HttpClient([
74+
'base_url' => 'http://example.com',
75+
'headers' => ['Authorization' => 'Bearer your_token']
76+
]);
77+
78+
$response = $client->get('/api/protected');
79+
```
80+
81+
---
82+
83+
## Helper Functions
84+
85+
To make the HTTP client easier to use, we provide a set of helper functions that allow you to quickly send `GET` and `POST` requests without needing to manually instantiate the `HttpClient` class every time.
86+
87+
### Available Helper Functions
88+
89+
#### 1. `http_client()`
90+
91+
This function creates and returns a new `HttpClient` instance with the provided configuration options.
92+
93+
```php
94+
$client = http_client([
95+
'base_url' => 'http://example.com',
96+
'headers' => ['Authorization' => 'Bearer your_token']
97+
]);
98+
```
99+
100+
#### 2. `http_post()`
101+
102+
Use this function to make a POST request with form-encoded data. It sends a request to the given URL with optional data and headers.
103+
104+
```php
105+
$response = http_post('http://example.com/api/login', [
106+
'username' => 'user123',
107+
'password' => 'secret'
108+
]);
109+
```
110+
111+
#### 3. `http_post_json()`
112+
113+
This function sends a POST request with JSON-encoded data. Useful for APIs expecting JSON input.
114+
115+
```php
116+
$response = http_post_json('http://example.com/api/create', [
117+
'title' => 'New Post',
118+
'body' => 'This is the content of the new post.'
119+
]);
120+
```
121+
122+
#### 4. `http_get()`
123+
124+
Make a GET request using this function. You can include query parameters and headers as needed.
125+
126+
```php
127+
$response = http_get('http://example.com/api/users', [
128+
'page' => 1,
129+
'limit' => 10
130+
]);
131+
```
132+
133+
### Example Usage of Helpers
134+
135+
```php
136+
// Make a GET request
137+
$response = http_get('http://api.example.com/items', ['category' => 'books']);
138+
$data = $response->bodyToArray();
139+
140+
// Make a POST request with form data
141+
$response = http_post('http://api.example.com/login', [
142+
'username' => 'user123',
143+
'password' => 'secret'
144+
]);
145+
146+
// Make a POST request with JSON data
147+
$response = http_post_json('http://api.example.com/posts', [
148+
'title' => 'Hello World',
149+
'content' => 'This is my first post!'
150+
]);
151+
```
152+
153+
These helper functions simplify making HTTP requests by reducing the need to manually create and configure the `HttpClient` for each request.
154+
155+
156+

‎composer.json

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"name": "phpdevcommunity/php-httpclient",
3+
"description": "A lightweight PHP HTTP client library without external dependencies. No need curl extension.",
4+
"type": "library",
5+
"license": "MIT",
6+
"authors": [
7+
{
8+
"name": "F. Michel",
9+
"homepage": "https://www.phpdevcommunity.com"
10+
}
11+
],
12+
"autoload": {
13+
"psr-4": {
14+
"PhpDevCommunity\\HttpClient\\": "src",
15+
"Test\\PhpDevCommunity\\HttpClient\\": "tests"
16+
},
17+
"files": [
18+
"src/helpers.php"
19+
]
20+
},
21+
"require": {
22+
"php": ">=7.4"
23+
},
24+
"require-dev": {
25+
"phpunit/phpunit": "^9.4"
26+
}
27+
}

‎src/Http/Response.php

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<?php
2+
3+
namespace PhpDevCommunity\HttpClient\Http;
4+
5+
final class Response
6+
{
7+
private string $body;
8+
private int $statusCode;
9+
private array $headers;
10+
11+
public function __construct(string $body, int $statusCode, array $headers)
12+
{
13+
$this->body = $body;
14+
$this->statusCode = $statusCode;
15+
$this->headers = $headers;
16+
}
17+
18+
public function getBody(): string
19+
{
20+
return $this->body;
21+
}
22+
23+
public function bodyToArray(): array
24+
{
25+
try {
26+
$decodedBody = json_decode($this->body, true, 512, JSON_THROW_ON_ERROR);
27+
}catch (\JsonException $e) {
28+
throw new \Exception('Invalid JSON format in response body : ' . $e->getMessage());
29+
}
30+
return $decodedBody;
31+
}
32+
33+
public function getStatusCode(): int
34+
{
35+
return $this->statusCode;
36+
}
37+
38+
public function getHeaders(): array
39+
{
40+
return $this->headers;
41+
}
42+
}

0 commit comments

Comments
 (0)