Skip to content

php.md

Latest commit

 

History

History
49 lines (41 loc) · 1.22 KB

php.md

File metadata and controls

49 lines (41 loc) · 1.22 KB

PHP Quickstart

Status: Experimental (no heartbeat or reconnect yet; keep sessions short)

Install

  • Published (after release): composer require just-every/code-bridge-php
  • From repo for dev/testing: 
    cd php
composer install

Run the example

npx code-bridge-host
export CODE_BRIDGE_URL=$(node -p "require('./.code/code-bridge.json').url")
export CODE_BRIDGE_SECRET=$(node -p "require('./.code/code-bridge.json').secret")
php php/examples/basic.php

Embed in your app

use CodeBridge\BridgeConfig;
use CodeBridge\Client;

$client = new Client(new BridgeConfig(
    getenv('CODE_BRIDGE_URL'),
    getenv('CODE_BRIDGE_SECRET'),
    'php-app',
    ['console', 'error']
));

$client->start();
$client->sendConsole('hello from php');
$client->sendError('sample error');
$client->stop();

API surface

  • start() → opens WS, sends auth + hello (protocol 2)
  • sendConsole(message, level='info')
  • sendError(message)
  • stop() → closes WS
  • Heartbeat/reconnect: not implemented yet

Notes & limits

  • No buffering; send assumes an open connection
  • Console + error events only
  • Use env CODE_BRIDGE_URL / CODE_BRIDGE_SECRET (defaults: ws://localhost:9877, dev-secret)