cravler/faye-app-bundle

CravlerFayeAppBundle

This bundle depends on faye-app., _(*1)

Installation

Step 1: Download the Bundle

``` bash composer require cravler/faye-app-bundle:2.x-dev, <sub>(*2)</sub>

This command requires you to have Composer installed globally, as explained
in the [installation chapter](https://getcomposer.org/doc/00-intro.md) of the Composer documentation.

### Step 2: Enable the Bundle

This bundle should be automatically enabled by [Flex](https://symfony.com/doc/current/setup/flex.html).
In case you don't use Flex, you'll need to manually enable the bundle by
adding the following line in the `config/bundles.php` file of your project:

``` php
<?php
// config/bundles.php

return [
    // ...
    Cravler\FayeAppBundle\CravlerFayeAppBundle::class => ['all' => true],
];

Step 3: Add routing

``` yaml, <sub>(*3)</sub>

config/routes.yaml

cravler_faye_app: resource: "@CravlerFayeAppBundle/Resources/config/routing.yaml", <sub>(*4)</sub>

### Step 4: Include Javascript

To include the relevant javascript libraries necessary for FayeApp, add these to your root layout file.

``` twig



{{ faye_app_javascript() }}

Usage

Create entry-point

``` php <?php // .../Acme/DemoBundle/EntryPoint/Example.php, <sub>(*5)</sub>

namespace Acme\DemoBundle\EntryPoint;, <sub>(*6)</sub>

use Cravler\FayeAppBundle\EntryPoint\AbstractEntryPoint;, <sub>(*7)</sub>

class Example extends AbstractEntryPoint { public function getId() { return 'acme-demo.example'; } }, <sub>(*8)</sub>

### Register entry-point

``` xml


<services>
    ...
    <service id="acme.demo.entry_point.example" class="Acme\DemoBundle\EntryPoint\Example">

        <call method="setEntryPointManager">
            <argument type="service" id="cravler_faye_app.service.entry_point_manager" />
        </call>

        <tag name="cravler_faye_app.entry_point" />
    </service>
    ...
</services>

Subscribing to channels

``` html, <sub>(*9)</sub>

### Sending messages

``` html

Configuration

The default configuration for the bundle looks like this:, <sub>(*10)</sub>

``` yaml cravler_faye_app: example: false user_provider: false #security.user.provider.concrete.[provider_name] route_url_prefix: /faye-app use_request_uri: false secret: ThisTokenIsNotSoSecretChangeIt app: scheme: ~ host: 127.0.0.1 port: ~ mount: /pub-sub options: {}, <sub>(*11)</sub>

## License

This bundle is under the MIT license. See the complete license in the bundle:

LICENSE ```, <sub>(*12)</sub>