Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/takielias/codeigniter-websocket
Codeigniter WebSocket Built for real-time application.
https://github.com/takielias/codeigniter-websocket
broadcast-messages codeigniter-library codeigniter-websocket php-websocket ratchet realtime-messaging websocket websockets
Last synced: about 2 months ago
JSON representation
Codeigniter WebSocket Built for real-time application.
- Host: GitHub
- URL: https://github.com/takielias/codeigniter-websocket
- Owner: takielias
- License: mit
- Created: 2018-12-08T06:45:28.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-05-31T17:30:37.000Z (over 2 years ago)
- Last Synced: 2024-12-15T23:07:46.882Z (about 2 months ago)
- Topics: broadcast-messages, codeigniter-library, codeigniter-websocket, php-websocket, ratchet, realtime-messaging, websocket, websockets
- Language: PHP
- Homepage: https://ebuz.xyz
- Size: 51.8 KB
- Stars: 57
- Watchers: 5
- Forks: 30
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Total Downloads][ico-downloads]][link-downloads]
# CodeIgniter WebSocket Library
CodeIgniter WebSocket library. It allows you to make powerfull realtime applications by using Ratchet ([Socketo.me](http://socketo.me) & [ratchet_client](https://github.com/romainrg/ratchet_client)) Websocket technology.
## WebSocket Library for Codeigniter 4.x https://github.com/takielias/codeigniter4-websocket
If you Face any problem you may check CodeIgniter WebSocket Example https://github.com/takielias/codeigniter-websocket-example
## :books: Dependencies
- PHP 5.6+
- CodeIgniter Framework (3.1.* recommanded)
- Composer
- PHP sockets extension enabled
## :beginner: Installation
### :arrow_right: Step 1 : Library installation by Composer
Just by running following command in the folder of your project :
```sh
composer require takielias/codeigniter-websocket
```
Don't forget to include your autoload to CI config file :
```php
$config['composer_autoload'] = FCPATH.'vendor/autoload.php';
```
### :arrow_right: Step 2 : One command Setup
If you want Single command installation just Execute the Command in the Project directory
**N.B:** It will make 2 new controllers Welcome.php and User.php
```sh
php vendor/takielias/codeigniter-websocket/install.php --app_path=application
```
Here app_path defines your default Codeigniter Application directory Name
**WOW You made it !!!** :heavy_check_mark:
Open two pages of your project on following url with different IDs :
`http://localhost/your project directory/index.php/user/index/1`
`http://localhost/your project directory/index.php/user/index/2`
:heavy_exclamation_mark: In this example, **recipient_id** is defined by **user_id**, as you can see, it's the **auth callback** who defines recipient ids.
If you have something like that, everything is ok for you:
You can try typing and sending something in each page (see cmd for more logs).
#### :arrow_right: Run the Websocket server Manually
If you want to enable debug mode type the command bellow in you'r project folder :
```sh
php index.php welcome index
```
If you see the message the message bellow, you are done (don't close your cmd) !
#### :arrow_right: Test the App
## Broadcast messages with your php App :boom: !
If you want to broadcast message with php script or something else you can use library like [textalk/websocket](https://github.com/Textalk/websocket-php) ***(who is included in my composer.json as required library)***
> *Note : The first message is mandatory and always here to perform authentication*
```php
$client = new Client('ws://0.0.0.0:8282');
$client->send(json_encode(array('user_id' => 1, 'message' => null)));
$client->send(json_encode(array('user_id' => 1, 'message' => 'Super cool message to myself!')));
```
## Authentication & callbacks :recycle:
The library allow you to define some callbacks, here's an example :
```php
class Welcome extends CI_Controller
{
public function index()
{
// Load package path
$this->load->add_package_path(FCPATH . 'vendor/takielias/codeigniter-websocket');
$this->load->library('Codeigniter_websocket');
$this->load->remove_package_path(FCPATH . 'vendor/takielias/codeigniter-websocket');
// Run server
$this->codeigniter_websocket->set_callback('auth', array($this, '_auth'));
$this->codeigniter_websocket->set_callback('event', array($this, '_event'));
$this->codeigniter_websocket->run();
}
public function _auth($datas = null)
{
// Here you can verify everything you want to perform user login.
// However, method must return integer (client ID) if auth succedeed and false if not.
return (!empty($datas->user_id)) ? $datas->user_id : false;
}
public function _event($datas = null)
{
// Here you can do everyting you want, each time message is received
echo 'Hey ! I\'m an EVENT callback'.PHP_EOL;
}
}
```
- **Auth** type callback is called at first message posted from client.
- **Event** type callback is called on every message posted.
# How to receive response into Codeigniter Controller ?
Please look at the Welcome.php controller.
public function index()
{
// Load package path
$this->load->add_package_path(FCPATH . 'vendor/takielias/codeigniter-websocket');
$this->load->library('Codeigniter_websocket');
$this->load->remove_package_path(FCPATH . 'vendor/takielias/codeigniter-websocket');
// Run server
$this->codeigniter_websocket->set_callback('auth', array($this, '_auth'));
$this->codeigniter_websocket->set_callback('event', array($this, '_event'));
$this->codeigniter_websocket->set_callback('roomleave', array($this, '_roomleave'));
$this->codeigniter_websocket->run();
}
public function _roomleave($data = null)
{
// Here you will receive data from the frontend roomleave event trigger.
echo 'Hey ! I\'m a room leave EVENT callback' . PHP_EOL;
}
The main concept is the callback function.
You would receive the response into the defined function. You can trigger the event from the front end like below using jQuery
socket.send(JSON.stringify({
'type': 'roomleave',
'room_name': targetName,
'user_id': "buzz4rd"
}));
It would trigger the function below
public function _roomleave($data = null)
{
// Here you will receive data from fron tend roomleave event trigger.
echo 'Hey ! I\'m a room leave EVENT callback' . PHP_EOL;
}
You May Check [Room Chat using PHP websocket](https://github.com/takielias/ci-socket-chat). It was built using [this](https://github.com/romainrg/ratchet_client)
## Bugs :bug: or feature :muscle:
Be free to open an issue or send pull request
## Support on Buy Me A Coffee
Hey dude! Help me out for a cup of ☕!
[ico-version]: https://img.shields.io/packagist/v/takielias/codeigniter-websocket.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/takielias/codeigniter-websocket.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/takielias/codeigniter-websocket
[link-downloads]: https://packagist.org/packages/takielias/codeigniter-websocket
[link-author]: https://github.com/takielias