laravel/nova-pennant

A Pennant Resource Tool for Laravel Nova

v1.0.0 2024-12-16 08:11 UTC

Requires

• php: ^8.1
• illuminate/support: ^10.0|^11.0
• laravel/pennant: ^1.11
• symfony/polyfill-php83: ^1.28

Requires (Dev)

• larastan/larastan: ^2.4
• laravel/nova: ^5.0
• laravel/nova-devtool: ^1.0.1
• laravel/pint: ^1.17
• orchestra/pest-plugin-testbench: ^2.0
• orchestra/testbench: ^8.24|^9.2
• phpstan/phpstan: ^1.11
• spatie/laravel-ray: ^1.39

MIT

• Taylor Otwell
• Mior Muhammad Zaki

• laravel
• laravel-nova
• laravel-pennant

README

This package makes it easy to view and manage Laravel Pennant features for your Laravel application inside of Nova.

Installation

You can install the Nova tool via Composer:

composer require laravel/nova-pennant

Next, you must register the tool within the User Resource.

use Laravel\Nova\PennantTool\PennantTool;

/**
 * Get the fields displayed by the resource.
 *
 * @return array
 */
public function fields(NovaRequest $request)
{
    return [
        ID::make()->sortable(),

        Text::make('Name')
            ->sortable()
            ->rules('required', 'max:255'),

        Text::make('Email')
            ->sortable()
            ->rules('required', 'email', 'max:254')
            ->creationRules('unique:users,email')
            ->updateRules('unique:users,email,{{resourceId}}'),

        Password::make('Password')
            ->onlyOnForms()
            ->creationRules('required', Rules\Password::defaults())
            ->updateRules('nullable', Rules\Password::defaults()),

        PennantTool::make(),
    ];
}

Usage

Authorization to Modify Feature Values

By default, Nova users will not have access to activate or deactivate features when they are authorized to see the resource. You need to use the canRun() method to authorize all or specific users.

use Laravel\Nova\Http\Requests\NovaRequest;
use Laravel\Nova\Nova;
use Laravel\Nova\PennantTool\PennantTool;

// ...

PennantTool::make()
    ->canRun(fn (NovaRequest $request) => Nova::user($request)->admin),

Password Confirmation

You can also require the user to confirm their password before activating or deactivating a feature by using requiresConfirmPassword() method:

use Laravel\Nova\PennantTool\PennantTool;

// ...

PennantTool::make()
    ->requiresConfirmPassword(),

Rich Feature Values

In order to configure rich values Nova would need to depend on a class-based feature and utilize options(mixed $scope) method:

namespace App\Features;

class UserTier 
{
    public $name = 'user-tier';

+   public function options(mixed $scope): array 
+   {
+      return ['solo', 'pro'];
+   }
}