# Transform PHP Vars to JavaScript [![Build Status](https://travis-ci.org/laracasts/PHP-Vars-To-Js-Transformer.png?branch=master)](https://travis-ci.org/laracasts/PHP-Vars-To-Js-Transformer) Often, you'll find yourself in situations, where you want to pass some server-side string/array/collection/whatever to your JavaScript. Traditionally, this can be a bit of a pain - especially as your app grows. This package simplifies the process drastically. ## Installation Begin by installing this package through Composer. ```bash composer require laracasts/utilities ``` > If you use Laravel 4: instead install `~1.0` of this package (and use the documentation for that release). For Laravel 5 (or non-Laravel), `~2.0` will do the trick! ### Laravel Users For Laravel users, there is a service provider you can make use of to automatically register the necessary bindings. > Laravel 5.5+ users: this step may be skipped, as we can auto-register the package with the framework. ```php // config/app.php 'providers' => [ '...', 'Laracasts\Utilities\JavaScript\JavaScriptServiceProvider' ]; ``` When this provider is booted, you'll gain access to a helpful `JavaScript` facade, which you may use in your controllers. ```php public function index() { JavaScript::put([ 'foo' => 'bar', 'user' => User::first(), 'age' => 29 ]); return View::make('hello'); } ``` > In Laravel 5, of course add `use JavaScript;` to the top of your controller. Using the code above, you'll now be able to access `foo`, `user`, and `age` from your JavaScript. ```js console.log(foo); // bar console.log(user); // User Obj console.log(age); // 29 ``` This package, by default, binds your JavaScript variables to a "footer" view, which you will include. For example: ```

My Page

@include ('footer') // <-- Variables prepended to this view ``` Naturally, you can change this default to a different view. See below. ### Defaults If using Laravel, there are only two configuration options that you'll need to worry about. First, publish the default configuration. ```bash php artisan vendor:publish // Or... php artisan vendor:publish --provider="Laracasts\Utilities\JavaScript\JavaScriptServiceProvider" ``` This will add a new configuration file to: `config/javascript.php`. ```php 'footer', /* |-------------------------------------------------------------------------- | JavaScript Namespace |-------------------------------------------------------------------------- | | By default, we'll add variables to the global window object. However, | it's recommended that you change this to some namespace - anything. | That way, you can access vars, like "SomeNamespace.someVariable." | */ 'js_namespace' => 'window' ]; ``` #### bind_js_vars_to_this_view You need to update this file to specify which view you want your new JavaScript variables to be prepended to. Typically, your footer is a good place for this. If you include something like a `layouts/partials/footer` partial, where you store your footer and script references, then make the `bind_js_vars_to_this_view` key equal to that path. Behind the scenes, the Laravel implementation of this package will listen for when that view is composed, and essentially paste the JS variables within it. #### js_namespace By default, all JavaScript vars will be nested under the global `window` object. You'll likely want to change this. Update the `js_namespace` key with the name of your desired JavaScript namespace. It can be anything. Just remember: if you change this setting (which you should), then you'll access all JavaScript variables, like so: ```js MyNewNamespace.varName ``` #### Note Run this artisan command after changing the view path. ``` php artisan config:clear ``` ### Symfony2 To use this component in Symfony2 applications you can try [this bundle](https://github.com/holyspecter/HospectPhpVarsToJsBundle), built on top of PHP-Vars-To-Js-Transformer. ### Without Laravel If you're not using Laravel, then you'll need to hard-wire things yourself. (Or, feel free to submit a pull request with an implementation for your desired framework.) First, create an implementation of the `Laracasts\Utilities\JavaScript\ViewBinder` interface. This class is in charge of inserting the given JavaScript into your view/page. ```php put(['foo' => 'bar']); ``` Now, you can access `window.foo` from your JavaScript. Remember, though, this is only necessary if you aren't using Laravel. If you are, then just reference the service provider, as demonstrated above. ## License [View the license](https://github.com/laracasts/PHP-Vars-To-Js-Transformer/blob/master/LICENSE) for this repo.