Download the PHP package dkvhin/nova-settings without Composer

Nova Settings

NOTE! THis is a forked from https://github.com/optimistdigital/nova-settings

I've modified this to be a per User settings approached instead of a global settings

This Laravel Nova package allows you to create custom settings in code (using Nova's native fields) and creates a UI for the users where the settings can be edited.

Requirements

• php: >=7.2
• laravel/nova: ^3.0

Features

• Settings fields management in code
• UI for editing settings
• Helpers for accessing settings
• Rule validation support
• Supports eminiarts/nova-tabs
• Supports nova-translatable w/ rule validation

Screenshots

Installation

Install the package in a Laravel Nova project via Composer and run migrations:

Register the tool with Nova in the tools() method of the NovaServiceProvider:

Usage

Registering fields

Define the fields in your NovaServiceProvider's boot() function by calling NovaSettings::setSettingsFields().

Casts

If you want the value of the setting to be formatted before it's returned, pass an array similar to Eloquent's $casts property as the second parameter.

Subpages

Add a settings page name as a third argument to list those settings in a custom subpage.

If you leave the custom name empty, the field(s) will be listed under "General".

To translate the page name, publish the translations and add a new key novaSettings.$subpage to the respective translations file, where $subpage is the name of the page (full lowercase, slugified).

Authorization

Show/hide all settings

If you want to hide the whole Settings area from the sidebar, you can authorize the NovaSettings tool like so:

Show/hide specific setting fields

If you want to hide only some settings, you can use ->canSee(fn () => ...) per field. Like so:

Helper functions

nova_get_settings(\$keys = null)

Call nova_get_settings() to get all the settings formated as a regular array. If you pass in $keys as an array, it will return only the keys listed.

nova_get_setting(\$key, \$default = null)

To get a single setting's value, call nova_get_setting('some_setting_key'). It will return either a value or null if there's no setting with such key.

You can also pass default value as a second argument nova_get_setting('some_setting_key', 'default_value'), which will be returned, if no setting was found with given key.

Configuration

The config file can be published using the following command:

The migration can also be published and overwritten using:

Localization

The translation file(s) can be published by using the following command:

You can add your translations to resources/lang/vendor/nova-settings/ by creating a new translations file with the locale name (ie et.json) and copying the JSON from the existing en.json.

Credits

• Tarvo Reinpalu

License

Nova Settings is open-sourced software licensed under the MIT license.