websuckit/websuckit-php

Websuckit PHP library

v1.0.0 2023-11-08 11:23 UTC

Requires

• php: >=8.1
• ext-curl: *
• phpseclib/phpseclib: ^3.0

Requires (Dev)

• mockery/mockery: ^1.6
• pestphp/pest: ^2.24

MIT

• Wisdom Praise

• http
• websocket
• communication
• realtime
• websuckit

README

For tutorials and more in-depth information about websuckit Channels, visit our official docs.

Usage Overview

The following topics are covered:

• Installation
• Initialization
• Channels
  • Create Channel
  • Get Channel
  • Get Channels
  • Get or Create Channel
  • Update Channel
  • Delete Channel
  • Accessing a channel's websocket URL

Installation

Using composer

composer require websuckit/websuckit-php

Initialization

require_once 'vendor/autoload.php';

use Websuckit\WebsuckitPhp\Config;
use Websuckit\WebsuckitPhp\Websuckit;

$config = new Config($_ENV['USER_ID'], $_ENV['ACCESS_KEY'], $_ENV['PUBLIC_KEY']);
$websuckit = new Websuckit($config);

You can get your USER_ID, ACCESS_KEY and PUBLIC_KEY from the websuckit dashboard.

Channel

Accessing a channel's websocket URL

It is possible to access a channel websocket URL by channel name, through the getConnectionUrl function

use Websuckit\WebsuckitPhp\Types\ChannelConnectionUrlConfig;

$channel = new ChannelConnectionUrlConfig('CHANNEL-NAME', 'CHANNEL-PASS-KEY', false);
$connection_url = $websuckit->getConnectionUrl($channel);

Create channel

$channel = $websuckit->createChannel('new-channel', 2);

Get channel

$channel = $websuckit->getChannel('CHANNEL-NAME');

Get channels (paginated)

$page = "0";
$per_page = "10";

//search variable that can be null
$search = "search-term"
$channels = $websuckit->getChannels($page, $per_page, $search);

Get or Create channel

$channel = $websuckit->getOrCreateChannel('CHANNEL-NAME');

Update channel

$channel = $websuckit->updateChannel('CHANNEL-ID', "CHANGE-CHANNEL-NAME", false, 2);

Delete channel

$websuckit->deleteChannel('CHANNEL-ID');