Laravel Localization Package for Vue

 

“Laravel Localization to Vue” is a new package by Stefan Ninic that converts Laravel localization into a format consumable by JavaScript packages like Lang.js, which is a Laravel translator class in Javascript. The package will help you quickly transform Laravel translations into a format consumable by a Vue.js application.

The example usage from the readme shows multiple ways that the package can be used to get Laravel translations into your frontend JavaScript framework, the first way being a View Composer:

// inside ServiceProvider

// With alias
use ExportLocalization;

View::composer('view.file', function ($view) {
    return $view->with([
        'messages' => ExportLocalization::export()->toArray(),
    ]);
});

The second way is using a configurable route that ships with this package, the default route looks like the following:

<script>
  let messages = axios.get('http://localhost/js/lang.js')
</script>

The setup in your Vue application looks like the following (using the lang.js NPM package):

// Inside blade view
<script>

    window.default_locale = "{{ config('app.lang') }}";
    window.fallback_locale = "{{ config('app.fallback_locale') }}";
    window.messages = @json($messages);

</script>

// app.js
import Vue from 'vue';
import Lang from 'lang.js';

const default_locale = window.default_language;
const fallback_locale = window.fallback_locale;
const messages = window.messages;

Vue.prototype.trans = new Lang({
  messages,
  locale: default_locale,
  fallback: fallback_locale
});

// Example.vue
<b-input v-model="query"
    type="text"
    :placeholder="trans.get('search.placeholder')"
>
</b-input>

I was able to sit down for a few minutes with Stefan and ask a few questions about his new localization package:

Laravel News: Can you give us some background on why you wrote this package, what inspired you to do so, or what need did you have?

Stefan: “Each time we need to use Laravel translation files inside JavaScript framework like Vue we need to write custom exporter, there’s no “auto export” of all those files in a format that’s accepted by JavaScript.”

Laravel News: How will this package help Laravel developers with their apps? What problems does it solve and opportunities does it bring?

Stefan: “It can automatically collect all translation files, even those from 3rd party packages from vendor folder and export them to different formats, array, JSON, collection and one special format accepted by Lang.js npm package which is #1 localization package for Vue.”

Laravel News: Can you explain your idea and use-case for the routing feature you mention in the readme?

Stefan: “[The] Routing feature can be used to get the translations from any part of code, even from mobile applications, desktop applications, anything that can issue HTTP request to server.”

Read More

Laravel Breadcrumbs Package

 

Breadcrumbs are one of those things that I don’t think about until I need them, and then I feel like I recreate a system for them in my application every time.

Laravel Breadcrumbs is a package by Dave James Miller that makes adding breadcrumb navigation to your application (relatively) painless with a simple API:

// Home
Breadcrumbs::for('home', function ($trail) {
    $trail->push('Home', route('home'));
});

// Home > About
Breadcrumbs::for('about', function ($trail) {
    $trail->parent('home');
    $trail->push('About', route('about'));
});

// Home > Blog
Breadcrumbs::for('blog', function ($trail) {
    $trail->parent('home');
    $trail->push('Blog', route('blog'));
});

To render breadcrumbs, you can pick from the following templates that ship with the Laravel Breadcrumb package at the time of writing:

• breadcrumbs::bootstrap4
• breadcrumbs::bootstrap3
• breadcrumbs::bootstrap2
• breadcrumbs::bulma
• breadcrumbs::foundation6
• breadcrumbs::materialize
• breadcrumbs::json-ld
• The path to a custom view: e.g. partials.breadcrumbs

Depending on which template you need, you configure it as a published configuration in config/breadcrumbs.php:

    'view' => 'breadcrumbs::bootstrap4',

And finally you render the breadcrumbs in your view:

{{ Breadcrumbs::render('category', $category) }}

This package even supports JSON-LD structured data for SEO purposes which is really helpful:

<head>
    ...
    {{ Breadcrumbs::view('breadcrumbs::json-ld', 'category', $category) }}
    ...
</head>

Read More

Automatically Open Files on Artisan “Make” Commands

 

“Open on Make” is a neat little package by Andrew Huggins that makes it easy to have newly created files open in your editor of choice.

When you run commands like php artisan make:controller, this package will listen for the command and open the file in the editor that you configure.

To configure your command to open in your editor of choice, you can configure the following environment variables, or publish the configuration:

OPEN_ON_MAKE_EDITOR=code
# Optionally set some flags, i.e.
OPEN_ON_MAKE_FLAGS="--reuse-window"

While writing about this, I opened a PR to disable the listener via configuration that was accepted yesterday.

The new open-on-make.enabled configuration option allows you to explicitly disable the package in a given environment, or in cases where a team member cannot use it for whatever reason:

OPEN_ON_MAKE_ENABLED=false

Being able to disable the package will be helpful in a team setting where not everyone might not have the same preferences or if you have some other reason to disable it in a given environment.

To give this package a try in your project, head over to the GitHub repo or install it with composer require --dev ahuggins/open-on-make.

Read More

Eventy WordPress-like Actions and Filters for Laravel

 

Eventy is a Laravel package by Tor Morten Jensen that brings WordPress-style actions and filters to your Laravel app.

This package has a lightweight API and makes it easy to build an action and filter system as found in WordPress. The action and filter system in WordPress is a powerful way to customize WordPress themes without modifying the template. For example, your users could easily tap into the <title></title> tag (think wp_title) to modify the way that title tags work without modifying the template.

Actions

Actions are code that you want to enable the ability to tap into code execution at a given point in your code.

Here’s the basic API for creating actions:

Eventy::action('my.hook', 'awesome');

The best place to add action listeners is in a service provider boot() method:

public function boot()
{
    Eventy::addAction('my.hook', function($what) {
        echo 'You are '. $what;
    }, 20, 1);
}

The Eventy::addAction() method accepts the action name, the callback, the priority, and the number of expected args. The lower the priority number, the earlier the execution.

Filters

Like WordPress filters, the Eventy library provides a filter method to modify passed values. Every time a filter is called it returns it’s value after running through various callbacks:

$value = Eventy::filter('my.hook', 'awesome');

The first argument is the filter name, and the second is the value. If no filter listeners are attached, the return value would be awesome.

The method siguature is the same as actions, including the priority and number of expected arguments:

Eventy::addFilter('my.hook', function($what) {
    $what = 'not '. $what;
    return $what;
}, 20, 1); // returns `not awesome`

You can even combine actions and filters together:

Eventy::addAction('my.hook', function($what) {
    $what = Eventy::filter('my.hook', 'awesome');
    echo 'You are '. $what;
});

Templates

Using the same examples from the project’s readme, here’s what the template syntax looks like for this package:

{{-- for example, `echo "awesome"` --}}
@action('my.hook', 'awesome')

You are @filter('my.hook', 'awesome')




Read More

Laravel Tenancy – Multi-Tenant Package for Laravel

 

Laravel Tenancy is a package by Daniël Klabbers, Paulo Trajano, and Bertrand Kintanar, for making your Laravel application multi-tenant:

The unobtrusive Laravel package that makes your app multi-tenant. Serving multiple websites, each with one or more hostnames from the same codebase. But with clear separation of assets, database and the ability to override logic per tenant.

Suitable for marketing companies that like to re-use functionality for different clients or start-ups building the next software as a service.

The Laravel Tenancy package includes the following features:

• Integration with the Laravel framework
• Event-driven extensible architecture
• Close – optional – integration into the web server
• The ability to add tenant-specific configs, code, routes, etc.

A couple of standard approaches to database architecture in multi-tenant applications include:

• One database for system data and tenants’ tables are prefixed
• One database for system data and separate tenant databases

Laravel Tenancy supports both methods, and you can manually customize it the way you want through event listeners.

The tenancy/tenancy package is the successor to hyn/multi-tenant, which means if you want to use this in production you’d probably use the hyn/multi-tenant package as tenancy/tenancy is still a work in progress.

The documentation for hyn/multi-tenant is an excellent place to start learning about Tenancy for requirements, installation, and implementation details.

Read More

Laravel Self-Diagnosis Package

 

Laravel Self-Diagnosis is a package by Marcel Pociot that performs self-diagnostics tests on your application. The checks include standard things like setting your APP_KEY environment variable when checking out a new project.

It happened to all of us @laravelphp devs:

We forgot to generate the APP_KEY, our .env.example has keys that our .env file is missing, we forgot to do a composer install, …

Here's our Laravel Self Diagnosis package to help you ????https://t.co/wZdSpyCfn9 pic.twitter.com/qaWlDyJBuf

— Marcel Pociot (@marcelpociot) July 4, 2018

The full list of checks at the time of writing include:

• Is the APP_KEY set?
• Are your composer dependencies up to date?
• Do you have the correct PHP version installed?
• Do you have the correct PHP extensions installed?
• Can a connection to the database be established?
• Do the storage and bootstrap/cache directories have the correct permissions?
• Does the .env file exist?
• Are there environment variables that exist in .env.example but not in .env?
• Are there any migrations that need to be run?
• Is the storage directory linked?

In a team environment, comparing one’s .env file to the .env.example file is super helpful to make sure you have everything configured.

You can even create custom checks by implementing an interface and configuring the check:

<?php

use BeyondCode\SelfDiagnosis\Checks\Check;

class MyCustomCheck implements Check
{
    /**
     * The name of the check.
     *
     * @return string
     */
    public function name(): string
    {
        return 'My custom check.';
    }

    /**
     * Perform the actual verification of this check.
     *
     * @return bool
     */
    public function check(): bool
    {
        return true;
    }

    /**
     * The error message to display in case the check does not pass.
     *
     * @return string
     */
    public function message() : string
    {
        return 'This is the error message that users see if "check" returns false.';
    }
}




Read More