stefanak-michal / thingsdb-php
PHP connector for ThingsDB
Fund package maintenance!
Ko-Fi
Requires
- php: ^8.2
- ext-mbstring: *
- ext-openssl: *
- rybakit/msgpack: ^0.9.1
Requires (Dev)
- phpunit/phpunit: ^11
This package is auto-updated.
Last update: 2024-10-24 13:20:14 UTC
README
PHP library for communication with ThingsDB over TCP socket.
✅ Requirements
- ThingsDB v1
- PHP ^8.2
- rybakit/msgpack
- mbstring
- openssl - Required only for connection with enabled SSL
💾 Installation - Composer
Run the following command in your project to install the latest applicable version of the package:
composer require stefanak-michal/thingsdb-php
🖥️ Usage
Class \ThingsDB\ThingsDB
provide all functionality related to socket connection with ThingsDB. It contains set of method which are based on documentation.
Every method has comment (annotation) with required information and link to documentation.
Available methods
Listening
Listening is specific state in which you wait for emitted packages from ThingsDB. You can read more about it in docs. PHP has max_execution_time and it is not allowed to set higher value than this. With max_execution_time=0 you can of course wait indefinitely.
join
, emit
, leave
also emit package towards the one who did it. Therefore, don't be surprised when first package received with calling listening
will be ON_JOIN|ON_LEAVE|ON_EMIT
event type.
Example
use ThingsDB\ThingsDB; $thingsDB = new ThingsDB(); $result = $thingsDB->auth(); // returns true on success $message = $thingsDB->query('@:stuff', '"Hello World!";'); // returns "Hello World!"
🔒 SSL
To make connection with enabled SSL you can use third parameter of constructor which is context. This context is provided to stream_context_create when creating connection. verify_peer
is the bare minimum to enable SSL communication.
use ThingsDB\ThingsDB; $thingsDB = new ThingsDB('localhost:9200', 15, [ 'socket' => ['tcp_nodelay' => true], 'ssl' => ['verify_peer' => true] ]);
⏱️ Timeout
Class constructor contains $timeout
argument. This timeout is for established socket connection. To set up
timeout for establishing socket connection itself you have to set ini directive default_socket_timeout
.
Setting up ini directive isn't part of connection class because function ini_set
can be disabled on production
environments for security reasons.
Error
\ThingsDB\error\ConnectException
This exception class is used for any exception related to connection on client side.
\ThingsDB\error\PackageException
This exception class is used when error occurs in ThingsDB. list of error types