包简介

Advanced modular WebSocket library for CodeIgniter 4 using Ratchet

README 文档

README

Gelişmiş, modüler ve özellik açısından zengin WebSocket kütüphanesi CodeIgniter 4 için. Ratchet WebSocket teknolojisini kullanarak güçlü gerçek zamanlı uygulamalar geliştirmenize olanak sağlar.

Özellikler

Temel Özellikler

✅ Ratchet WebSocket desteği
✅ JWT tabanlı kimlik doğrulama
✅ Oda/Kanal (Room/Channel) yönetimi
✅ Gerçek zamanlı mesajlaşma
✅ Broadcast desteği
✅ Callback sistemi

Gelişmiş Özellikler

🔥 Modüler Mimari: Kolayca genişletilebilir yapı
🔥 Middleware Desteği: Özel middleware'ler ekleyebilirsiniz
🔥 Event System: Olay tabanlı mimari
🔥 Presence System: Kullanıcı online/offline durumu takibi
🔥 Rate Limiting: Mesaj gönderme hızı sınırlama
🔥 Connection Management: Gelişmiş bağlantı yönetimi
🔥 Room Management: Oda bazlı mesajlaşma
🔥 Message History: Mesaj geçmişi saklama (opsiyonel)
🔥 IP-based Connection Limiting: IP bazlı bağlantı sınırlama
🔥 SSL/TLS Desteği: Güvenli bağlantılar
🔥 CORS Yapılandırması: Cross-origin desteği
🔥 Logging: Detaylı loglama sistemi
🔥 Metrics: Performans metrikleri (opsiyonel)

Kurulum

Composer ile Kurulum

composer require Yakupeyisan/codeigniter4-websocket

Yapılandırma Dosyasını Yayınlama

php spark websocket:publish

Bu komut size şunları soracak:

Config dosyası yayınlama
Controller yayınlama
Views yayınlama

Hızlı Başlangıç

1. Yapılandırma

app/Config/Websocket.php dosyasını düzenleyin:

<?php

namespace Config;

use Yakupeyisan\CodeIgniterWebSocket\Config\Websocket as BaseWebsocket;

class Websocket extends BaseWebsocket
{
    public $host = '0.0.0.0';
    public $port = 8282;
    public $auth = true;
    public $jwtKey = 'your-secret-key-here';
    public $debug = true;
}

2. Controller Oluşturma

app/Controllers/WebSocketController.php:

<?php

namespace App\Controllers;

use CodeIgniter\Controller;

class WebSocketController extends Controller
{
    public function start()
    {
        $ws = service('websocket');
        $ws->setCallback('auth', [$this, '_auth']);
        $ws->setCallback('event', [$this, '_event']);
        $ws->start();
    }

    public function _auth($data)
    {
        // Kimlik doğrulama mantığınızı buraya yazın
        // Örnek: Veritabanından kullanıcı kontrolü
        if (!empty($data->user_id)) {
            return (int)$data->user_id;
        }
        return false;
    }

    public function _event($data)
    {
        // Olay işleme mantığınızı buraya yazın
        log_message('info', 'WebSocket event: ' . json_encode($data));
    }
}

3. Route Ekleme

app/Config/Routes.php:

$routes->get('websocket/start', 'WebSocketController::start');
$routes->get('websocket/client/(:num)', 'WebSocketController::client/$1');

4. WebSocket Sunucusunu Başlatma

php spark websocket:start

Veya özel host/port ile:

php spark websocket:start --host=127.0.0.1 --port=8282 --debug

5. Client Tarafı

HTML/JavaScript örneği:

<!DOCTYPE html>
<html>
<head>
    <title>WebSocket Client</title>
</head>
<body>
    <div id="messages"></div>
    <input type="text" id="message" placeholder="Mesajınız...">
    <button onclick="sendMessage()">Gönder</button>

    <script>
        var ws = new WebSocket('ws://localhost:8282');
        var token = null;

        ws.onopen = function() {
            // Kimlik doğrulama
            ws.send(JSON.stringify({
                type: 'socket',
                user_id: 1
            }));
        };

        ws.onmessage = function(e) {
            var data = JSON.parse(e.data);
            
            if (data.type === 'token') {
                token = data.data.token;
            } else if (data.type === 'chat') {
                document.getElementById('messages').innerHTML += 
                    '<div>' + data.message + '</div>';
            }
        };

        function sendMessage() {
            var message = document.getElementById('message').value;
            
            ws.send(JSON.stringify({
                type: 'chat',
                message: message,
                token: token
            }));
        }
    </script>
</body>
</html>

Kullanım Örnekleri

Oda (Room) Kullanımı

// Server tarafı
$ws = service('websocket');

// Odaya mesaj gönderme
$ws->sendToRoom('room-123', [
    'type' => 'message',
    'message' => 'Merhaba!',
    'userId' => 1
]);

// Client tarafı
// Odaya katılma
ws.send(JSON.stringify({
    type: 'roomjoin',
    room: 'room-123',
    token: token
}));

// Odaya mesaj gönderme
ws.send(JSON.stringify({
    type: 'roomchat',
    room: 'room-123',
    message: 'Merhaba!',
    token: token
}));

Broadcast

// Tüm bağlantılara mesaj gönderme
websocket_broadcast([
    'type' => 'notification',
    'message' => 'Sistem bakımı başlıyor'
]);

// Belirli bağlantıları hariç tutma
websocket_broadcast([
    'type' => 'notification',
    'message' => 'Yeni mesaj'
], [123, 456]); // Bu ID'ler hariç

Presence System

$ws = service('websocket');
$presence = $ws->getPresenceManager();

// Online kullanıcıları alma
$onlineUsers = $presence->getOnlineUsers();

// Kullanıcı online mı kontrol etme
if ($presence->isOnline($userId)) {
    // Kullanıcı online
}

Event System

$ws = service('websocket');
$dispatcher = $ws->getEventDispatcher();

// Event dinleme
$dispatcher->on('message', function($data) {
    log_message('info', 'Message received: ' . json_encode($data));
});

// Event tetikleme
$dispatcher->dispatch('custom_event', ['data' => 'value']);

Middleware Kullanımı

// Özel middleware oluşturma
namespace App\Middleware;

use Yakupeyisan\CodeIgniterWebSocket\Middleware\MiddlewareInterface;
use Ratchet\ConnectionInterface;

class CustomMiddleware implements MiddlewareInterface
{
    public function handle(ConnectionInterface $connection, object $message, callable $next)
    {
        // Ön işlemler
        if (/* some condition */) {
            return false; // Mesajı engelle
        }
        
        // Sonraki middleware'e geç
        return $next($connection, $message);
    }
}

// Middleware ekleme
$ws = service('websocket');
$ws->addMiddleware(new \App\Middleware\CustomMiddleware());

Helper Fonksiyonlar

// WebSocket servisini alma
$ws = websocket_service();

// Broadcast
websocket_broadcast($message, $exclude = []);

// Belirli client'a gönderme
websocket_send_to_client($clientId, $message);

// Odaya gönderme
websocket_send_to_room($room, $message, $exclude = []);

// Bağlantı sayısı
$count = websocket_connection_count();

// Oda bağlantı sayısı
$roomCount = websocket_room_count('room-123');

Yapılandırma Seçenekleri

public $host = '0.0.0.0';                    // Sunucu host
public $port = 8282;                         // Sunucu port
public $ssl = false;                         // SSL/TLS aktif
public $sslCertPath = null;                 // SSL sertifika yolu
public $sslKeyPath = null;                  // SSL key yolu
public $auth = false;                        // Kimlik doğrulama aktif
public $jwtKey = 'secret-key';              // JWT secret key
public $tokenTimeout = 60;                  // Token timeout (dakika)
public $debug = false;                      // Debug modu
public $timer = false;                      // Timer aktif
public $interval = 1;                       // Timer interval (saniye)
public $maxConnectionsPerIp = 10;           // IP başına max bağlantı
public $rateLimitPerMinute = 60;             // Dakikada max mesaj
public $presenceEnabled = true;            // Presence sistemi
public $presenceHeartbeatInterval = 30;    // Heartbeat interval
public $messageHistoryEnabled = false;     // Mesaj geçmişi
public $messageHistoryLimit = 100;          // Geçmiş limiti
public $corsEnabled = true;                // CORS aktif
public $corsOrigins = ['*'];                // CORS origins
public $loggingEnabled = true;             // Logging aktif
public $logLevel = 'info';                 // Log seviyesi

Callback'ler

Desteklenen callback türleri:

auth - Kimlik doğrulama
event - Mesaj olayları
close - Bağlantı kapanma
citimer - Timer olayları
roomjoin - Odaya katılma
roomleave - Odadan ayrılma
roomchat - Oda mesajlaşması
connect - Bağlantı açılma
disconnect - Bağlantı kapanma
error - Hata olayları
presence - Presence güncellemeleri
typing - Yazma göstergesi
read - Okundu bilgisi

Güvenlik

JWT tabanlı kimlik doğrulama
Rate limiting
IP bazlı bağlantı sınırlama
SSL/TLS desteği
CORS yapılandırması

Performans

Verimli bağlantı yönetimi
Oda bazlı mesajlaşma
Rate limiting ile aşırı yüklenmeyi önleme
Mesaj geçmişi için opsiyonel depolama

Lisans

MIT License

Katkıda Bulunma

Katkılarınızı bekliyoruz! Lütfen pull request göndermeden önce:

Fork edin
Feature branch oluşturun (git checkout -b feature/amazing-feature)
Commit edin (git commit -m 'Add amazing feature')
Push edin (git push origin feature/amazing-feature)
Pull Request açın

Destek

Sorularınız için issue açabilir veya dokümantasyonu inceleyebilirsiniz.

Teşekkürler

Ratchet - WebSocket kütüphanesi
CodeIgniter 4 - PHP framework

yakupeyisan/codeigniter4-websocket 适用场景与选型建议

yakupeyisan/codeigniter4-websocket 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 0 次下载、GitHub Stars 达 0，最近一次更新时间为 2025 年 12 月 22 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「websocket」「real-time」「codeigniter」「Socket」「Ratchet」「chat」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 yakupeyisan/codeigniter4-websocket 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 yakupeyisan/codeigniter4-websocket 我们能提供哪些服务？

定制开发 / 二次开发

基于 yakupeyisan/codeigniter4-websocket 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 yakupeyisan/codeigniter4-websocket 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

nahid/talk 1.62k

Talk is a Laravel based realtime messaging, chatting and conversation system. It helps to develop users messaging, chatting and conversations in easy way.

maykonn/codeigniter-predis 12

The CodeIgniter Redis package

boxalino/rtux-magento2 1

Boxalino Real Time User Experience (RTUX) Magento2 plugin

cyberdeep/laravel-agora-token-generator 0

Laravel package for generating Agora.io tokens (RTC, RTM, Chat) with support for both V1 and V2 token formats

broadcastt/broadcastt-php-http 1

PHP library for Broadcastt HTTP API

matviib/notifier 62

NO LIBRARIES socket per page bridge for your Laravel application.

yakupeyisan/codeigniter4-websocket

包简介

关键字：