coreplex/bridge

A php package to share data from your back end code to the front end

v0.2.0 2017-01-23 09:35 UTC

Requires

• php: >=5.4.0

Requires (Dev)

• phpunit/phpunit: 4.8.*

MIT

• Michael Jennings
• Coreplex

• laravel

README

Ever found yourself needing to access back end data in your JavaScript or front end code? Well that's the aim of this package.

• Installation
  • Laravel 5 Integration
• Usage
• Sharing Data
• Rendering Data

Installation

This package requires PHP 5.4+, and includes a Laravel 5 Service Provider and Facade.

We recommend installing the package through composer. You can either call composer require coreplex/notifier in your command line, or add the following to your composer.json and then run either composer install or composer update to download the package.

"coreplex/bridge": "~0.1"

Laravel 5 Integration

To use the package with Laravel 5 firstly add the javascript service provider to the list of service providers in app/config/app.php.

'providers' => array(

  Coreplex\Bridge\JavascriptServiceProvider::class,

);

If you wish to use the facade then add the following to your aliases array in app/config/app.php.

'aliases' => array(

  'Javascript'  => Coreplex\Bridge\Facades\Javascript::class,

);

Usage

To get started with the JavaScript component you simply need to create a new instance of the Javascript class.

$bridge = new Javascript();

Or if you are using laravel then you can access the class via it's facade or you can resolve it from the IOC container by its contract.

Javascript::share('foo, 'bar');

public function __construct(Coreplex\Bridge\Contracts\Javascript $bridge)
{
    $this->bridge = $bridge;
}

Sharing Data

To share data to the front end use the share method. You can either pass a key and value as arguments or pass an array of key value pairs. The share method can also be chained if you prefer.

$bridge->share('foo', 'bar')->share('baz', 'qux');
// OR
$bridge->share(['foo' => 'bar', 'baz' => 'qux']);

Rendering Data

To access your shared data on the front end call the renderSharedData method. This will then echo out all of the necessary scripts.

echo $bridge->renderSharedData();