day4/switch-locale

A Laravel Nova tool to switch the locale

Installs: 24 173

Dependents: 1

Suggesters: 0

Security: 0

Stars: 1

Watchers: 1

Forks: 15

Language:Vue

0.5.9 2021-07-19 10:08 UTC

This package is auto-updated.

Last update: 2024-10-19 17:09:40 UTC


README

For Astrotomic's Laravel Translatable

This tool provides a nice header dropdown to quickly switch between locales. Locale is cached per user and sets the main app locale.

It also provides a Language field which gives you the status of the translation on a specific resource.

NOTE If you use Spatie's Laravel Translatable then use Laravel Nova Locale Anywhere Tool

Installation

composer require day4/switch-locale

php artisan vendor:publish --tag=public

Usage

To begin using this, you must first register the tool in NovaServiceProvider under tools. The tool utilises Astrotomic's Laravel Translatable package.

public function tools()
{
    return [
        new SwitchLocale([
            "locales" => [
                "en" => "English",
                "de" => "German"
            ],
            "useFallback" => false,
            "customDetailToolbar" => false //optional
        ])
    ];
}

Dropdown

The package provides a switch for the languages that you have to insert into Nova's layout file. You can do that by overwriting the layout.blade.php file and insert it after the user dropdown.

…
<dropdown class="ml-auto h-9 flex items-center dropdown-right">
    @include('nova::partials.user')
</dropdown>

<switch-locale-dropdown class="ml-6"></switch-locale-dropdown>
…

Resource status field

You can then define the field in the resource.

use Day4\SwitchLocale\Language;

    Language::make(__('Translation'))

Delete translation toolbar button

The package provides a CustomDetailToolbar component that you can toggle via configuration. Optionally, you can also only grab the <delete-toolbar-button> from the package and paste it into your own custom detail toolbar.

Language Permissions

If you want to allow users access to only certain languages this tool can also display which langauges they have access to.

Setup

In order for this to work the user needs to have a locale property that returns an object of locale with boolean values for which the user has access to.

// User table migration

$table->string('locale')->default('{}');
// User Model app/User.php

protected $casts = [
    'email_verified_at' => 'datetime',
    'locale' => 'array'
];

public function allowedLocale() {
    return $this->allowedAllLocale() || $this->locale[app()->getLocale()];
}

public function allowedAllLocale() {
    return $this->isAdmin(); // As an example, admin is allowed all locale
}
// User Nova Resource app/Nova/User.php

use Laravel\Nova\Fields\BooleanGroup;
use Day4\SwitchLocale\SwitchLocale;
…

    BooleanGroup::make(__('Allowed Locale'), 'locale')->options(SwitchLocale::getLocales()),

Example Usage

// PostPolicy

<?php

namespace App\Policies;

use App\Post;
use App\User;
use Illuminate\Auth\Access\HandlesAuthorization;

class PostPolicy
{
    use HandlesAuthorization;

    /**
     * Determine whether the user can view any posts.
     */
    public function viewAny(User $user)
    {
        return true;
    }

    /**
     * Determine whether the user can view the post.
     */
    public function view(User $user, Post $post)
    {
        return $post->status == 'published' || ($user && $user->id == $post->author_id);
    }

    /**
     * Determine whether the user can create posts.
     */
    public function create(User $user)
    {
        return $user && $user->allowedLocale();
    }

    /**
     * Determine whether the user can update the post.
     */
    public function update(User $user, Post $post)
    {
        return $user && $user->allowedLocale();
    }

    /**
     * Determine whether the user can update the post.
     */
    public function delete(User $user, Post $post)
    {
        return $user && $user->allowedLocale();
    }
}


Note You should probably have some other permissions and rules in place to limit users from giving them selves access to languages etc.

Credits

Originally forked from slovenianGooner