eole/sandstone

Silex RestApi with Websockets.

Sandstone

, _(*1)

PHP microframework designed to build a RestApi working together with a websocket server., _(*2)

Build a real time RestApi!, _(*3)

:speech_balloon: New (18 April 2018)

I opened a chat channel where you can get help, give feedback, and talk about Sandstone (Mattermost instance):, _(*4)

:speech_balloon: https://framateam.org/sandstone :speech_balloon:, _(*5)

Install

``` bash composer require eole/sandstone, <sub>(*6)</sub>

## Usage

### Create a Sandstone application

Sandstone is a Silex application with websockets:

``` php
$app = new Eole\Sandstone\Application();

Declare a websocket topic

Just as easy as declaring a silex route:, <sub>(*7)</sub>

``` php $app->topic('chat/{channel}', function ($topicPattern, $arguments) { $channelName = $arguments['channel'];, <sub>(*8)</sub>

return new ChatTopic($topicPattern, $channelName);

});, <sub>(*9)</sub>

See [ChatTopic class here](https://eole-io.github.io/sandstone-doc/examples/multichannel-chat).


### Send push notifications

When an endpoint is called on the RestApi, i.e `POST /api/articles` and update a resource,
you can send a push notification to notify this update.

On the RestApi stack:

``` php
use Symfony\Component\HttpFoundation\Response;

$app->post('api/articles', function () use ($app) {
    // Dispatch an event on article creation
    $app['dispatcher']->dispatch('article.created', new ArticleEvent());

    return new Response([], 201);
});

// Send all 'article.created' events to push server
$app->forwardEventToPushServer('article.created');

Then on the websocket stack:, <sub>(*10)</sub>

``` php use Symfony\Component\EventDispatcher\EventSubscriberInterface; use Eole\Sandstone\Websocket\Topic;, <sub>(*11)</sub>

class MyWebsocketTopic extends Topic implements EventSubscriberInterface { public static function getSubscribedEvents() { return [ 'article.created' => 'onArticleCreated', ]; }, <sub>(*12)</sub>

public function onArticleCreated(ArticleEvent $event)
{
    $this->broadcast([
        'message' => 'An article has just been published: '.$event->title,
    ]);
}

} ```, <sub>(*13)</sub>

Examples

Working examples from scratch:, <sub>(*14)</sub>

• RestApi + Websocket + push notification
• Authentication on RestApi and Websockets
• Chat example

Documentation

See the full documentation here, <sub>(*15)</sub>

, <sub>(*16)</sub>

Sandstone edition

You're planning to start a new real-time Rest Api application based on Sandstone?, <sub>(*17)</sub>

You may be interested by Sandstone edition., <sub>(*18)</sub>

It already integrates a Sandstone application with a docker environment, a database, debug tools..., <sub>(*19)</sub>

Get started with Sandstone edition., <sub>(*20)</sub>

Misc

Articles about Sandstone:, <sub>(*21)</sub>

• Sandstone explained to NodeJS, Python or PHP users
• Creating a poker planning application with PHP and websockets
• What is Sandstone, What can I do with Sandstone

Big picture: https://eole-io.github.io/sandstone-doc/big-picture, <sub>(*22)</sub>

Changelog

See Releases page., <sub>(*23)</sub>

License

This library is under MIT License., <sub>(*24)</sub>