2017 © Pedro Peláez
 

library laravel-js-helper

Transform your PHP to JavaScript

image

mikkellindblom/laravel-js-helper

Transform your PHP to JavaScript

  • Friday, February 9, 2018
  • by mikkellindblom
  • Repository
  • 1 Watchers
  • 0 Stars
  • 41 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 185 Forks
  • 0 Open issues
  • 2 Versions
  • 24 % Grown

The README.md

Laravel js helper class

Installation

Begin by installing this package through Composer., (*1)

composer require mikkellindblom/laravel-js-helper

Ussage

When this provider is booted, you'll gain access to a helpful JavaScript facade, which you may use in your controllers., (*2)

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., (*3)

Using the code above, you'll now be able to access foo, user, and age from your JavaScript., (*4)

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:, (*5)

<body>
    <h1>My Page</h1>

    @include ('footer') // <-- Variables prepended to this view
</body>

Naturally, you can change this default to a different view. See below., (*6)

Defaults

If using Laravel, there are only two configuration options that you'll need to worry about. First, publish the default configuration., (*7)

php artisan vendor:publish

// Or...

php artisan vendor:publish --provider="Mikkellindblom\js-helper\JavaScript\JavaScriptServiceProvider"

This will add a new configuration file to: config/javascript.php., (*8)

<?php

return [

    /*
    |--------------------------------------------------------------------------
    | View to Bind JavaScript Vars To
    |--------------------------------------------------------------------------
    |
    | Set this value to the name of the view (or partial) that
    | you want to prepend all JavaScript variables to.
    |
    */
    'bind_js_vars_to_this_view' => '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., (*9)

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., (*10)

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:, (*11)

MyNewNamespace.varName

Note

Run this artisan command after changing the view path., (*12)

php artisan config:clear

License

View the license for this repo., (*13)

The Versions

09/02 2018

dev-master

9999999-dev

Transform your PHP to JavaScript

  Sources   Download

MIT

The Requires

 

The Development Requires

by Mikkel lindblom

laravel javascript

09/02 2018

1.0

1.0.0.0

Transform your PHP to JavaScript

  Sources   Download

MIT

The Requires

 

The Development Requires

by Mikkel lindblom

laravel javascript