*Attention*:
Installing this Bundle basically lets anyone side step the security firewall.
Therefore its important to either secure the multiplex route or to implement
security checks inside all relevant controllers
Installation
============
1. Add this bundle to your project with Composer:
```
$ php composer.phar require liip/multiplex-bundle
```
2. Add this bundle to your application's kernel:
``` php
// app/AppKernel.php
public function registerBundles()
{
return array(
// ...
new Liip\MultiplexBundle\LiipMultiplexBundle(),
// ...
);
}
```
Configuration
=============
The following Configuration Options exists:
* `allow_externals` : if enabled also external urls can be multiplexed (default: *true*)
* `display_errors` : if enabled and an error occured, the error message will be returned, otherwise (if available) the http status code message (default: *true*)
* `route_option` : only used in combination with `restrict_routes`, defines the route option which should be looked up if `restrict_routes` is on (default: *multiplex_expose*)
* `restrict_routes` : if enabled only routes with the `route_option` are multiplexable (default: *false*)
Application Configuration
-------------------------
here the default config
``` yml
liip_multiplex:
allow_externals: true
display_errors: true
route_option: 'multiplex_expose'
restrict_routes: false
Routing Configuration
if you want to restrict multiplexing to specific routes, define the option in each route you want to expose, (*9)
``` xml
MyBundle:Controller:index, (*10)
and don't forget to set `restrict_routes` to `true`!
Usage
=====
This Bundles provides a decent Javascript Library to use the Multiplexer Endpoint.
Integration of the Javascript
-----------------------------
``` twig
{% javascripts
"@LiipMultiplexBundle/Resources/public/js/ajax_multiplexer.js"
output='js/multiplexer.js'
%}
<script src="{{ asset_url }}"></script>
{% endjavascripts %}
Using the Javascript Multiplexer
``` javascript, (*11)
//configuring the Multiplexer
Multiplexer.setEndpoint('/path/to/multiplexer/endpoint'); //as in your routing defaults to /multiplex.json
Multiplexer.setFormat('json'); //only useful exchange format, (*12)
//adding Requests to the Multiplexer
Multiplexer.add(
{'uri' : '/foo/bar', 'method' : 'GET', 'parameters' : {'foo':'bar'}}, //the Request Object
function(content) { /* ... /}, // the Success Callback
function(content) { / ... */} // the Error Callback
);, (*13)
Multiplexer.add(
{'uri' : 'http://google.com', 'method' : 'GET', 'parameters' : {'q':'Symfony2'}},
function(content) { /* this callback is called on success for this request/},
function(content) { / this callback is called on error for this request*/}
);, (*14)
//pushing all Requests to the Server
Multiplexer.call(
function(r){ /* ... / }, //the global success callback (optional)
function(r){ / ... */ } //the global error callback (optional)
);, (*15)
//pushing only a set of Requests to the Server
Multiplexer.call(['/foo/bar']);, (*16)
```, (*17)
Tests
To run the unit tests, require all dependencies, (*18)
Wallogit.com
