reflect/client-php
1
0
Fork 0
mirror of https://codeberg.org/reflect/reflect-client-php.git synced 2025-09-13 17:43:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix(doc): wording

Browse source
This commit is contained in:
Victor Westerlund 2023-03-16 15:46:33 +01:00 • committed by GitHub
parent d9b9dc3b9e
commit 69c9c5928e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -1,10 +1,10 @@
# Reflect API client for PHP # Reflect API client for PHP
Make requests to an API built using the Reflect API framework over HTTP or UNIX sockets. This program comes with both an extendable/instantiable class that you can integrate with existing PHP code, or as a stand-alone CLI which can be piped into other programs. Make requests to an API built using the [Reflect API](https://github.com/VictorWesterlund/reflect) framework over HTTP or UNIX sockets. This program comes with both an extendable/instantiable class that you can integrate with existing PHP code, or as a stand-alone CLI which can be run by itself or UNIX piped into other programs.
--- ---
Make a request with `Client->call()`. It will return the response as an array of length 2. Make a request with `Client->call()`. It will always return the response as an array of length 2.
- The first value is the HTTP-equivalent response code. - The first value is the HTTP-equivalent response code.
- The second value is the response body - The second value is the response body
@ -21,7 +21,7 @@ $client->call("foo", Method::POST, [
## How to use ## How to use
Requires PHP 8.1 or newer, and of course an instance of the [Reflect socket server](https://github.com/VictorWesterlund/reflect/wiki/UNIX-Sockets) running on the same machine. Requires PHP 8.1 or newer, and of course a Reflect API endpoint.
1. **Install with composer** 1. **Install with composer**
@ -75,7 +75,7 @@ php client "/run/reflect.sock" "foo?bar=biz" "POST" "[\"foo\" => \"bar\"]" # (st
--- ---
Requires PHP CLI 8.1 or greater, and of course an instance of the [Reflect socket server](https://github.com/VictorWesterlund/reflect/wiki/UNIX-Sockets) running on the same machine. Requires PHP CLI 8.1 or greater, and of course a Reflect API endpoint.
1. **Clone repo** 1. **Clone repo**
@ -87,5 +87,5 @@ Requires PHP CLI 8.1 or greater, and of course an instance of the [Reflect socke
``` ```
cd reflect-client-php cd reflect-client-php
php client <socket_file> <endpoint> <http_method> [payload] php client <url_or_socket_file_path> <endpoint> <http_method> [payload]
``` ```