Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nijens/sse
A Server-Sent Events server implementation in PHP.
https://github.com/nijens/sse
event-source php php7 server-sent-events sse
Last synced: 5 days ago
JSON representation
A Server-Sent Events server implementation in PHP.
- Host: GitHub
- URL: https://github.com/nijens/sse
- Owner: nijens
- License: mit
- Created: 2019-04-28T13:22:56.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-07-10T12:17:15.000Z (over 2 years ago)
- Last Synced: 2024-05-01T14:07:32.259Z (7 months ago)
- Topics: event-source, php, php7, server-sent-events, sse
- Language: PHP
- Homepage:
- Size: 41 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SSE
[![Latest version on Packagist][ico-version]][link-version]
[![Software License][ico-license]][link-license]
[![Build Status][ico-build]][link-build]
A Server-Sent Events server implementation in PHP.
For more information about SSE, see the [MDN documentation][link-mdn-web-docs].
## Installation
Open a command console, enter your project directory and execute:
```bash
composer require nijens/sse
```
## Usage
The SSE library functions with two main components:
1. An event publisher implementation (eg. the `DateTimeEventPublisher`): Providing the events to be sent
2. The `SseKernel`: Responsible for checking with the event publisher for new events and sending the events to the client (browser)
The following example shows how to initialize the `SseKernel` with an event publisher:
```php
handle($request);
$response->send();
```
### Integrating the SseKernel inside a Symfony controller
When you're using the [Symfony Framework][link-symfony-framework] to create your application, you're still able to use the `SseKernel`
implementation inside a controller.
The following example shows a crude implementation of the `SseKernel` inside a controller:
```php
handle($request);
}
}
```
Optionally, you could use [Dependency Injection][link-symfony-dependency-injection] to change the kernel and
event publisher to services.
### Creating your own event publisher
This library provides the following event publishers:
* `DateTimeEventPublisher`: A working example, providing the current time as event
* `TransportEventPublisher`: A event publisher implementation for implementing a transport (eg. MySQL database implementation)
You're able to create your own event publisher implementation by implementing the `EventPublisherInterface` or
`ConnectedClientEventPublisherInterface`.
If you only want read the events from a database or other storage, it is recommended to create a `TransportInterface`
implementation for the `TransportEventPublisher`.
## Credits and acknowledgements
* Author: [Niels Nijens][link-author]
Also see the list of [contributors][link-contributors] who participated in this project.
## License
The SSE package is licensed under the MIT License. Please see the [LICENSE file][link-license] for details.
[ico-version]: https://img.shields.io/packagist/v/nijens/sse.svg
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg
[ico-build]: https://github.com/nijens/sse/workflows/Continuous%20Integration/badge.svg
[link-version]: https://packagist.org/packages/nijens/sse
[link-license]: LICENSE
[link-build]: https://github.com/nijens/sse/actions?workflow=Continuous+Integration
[link-mdn-web-docs]: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events
[link-symfony-framework]: https://symfony.com
[link-symfony-dependency-injection]: https://symfony.com/doc/current/service_container.html
[link-author]: https://github.com/niels-nijens
[link-contributors]: https://github.com/nijens/sse/contributors