backpack/settings

Application settings interface for Laravel 5 using Backpack CRUD.

Friday, April 20, 2018
by tabacitu
Repository
18 Watchers
77 Stars
107,100 Installations

PHP
4 Dependents
0 Suggesters
41 Forks
5 Open issues
48 Versions
13 % Grown

The README.md

Backpack\Settings

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

An interface for the administrator to easily change application settings. Uses Laravel Backpack. Works on Backpack v4, v5 and v6., _(*2)

Security updates and breaking changes

Please subscribe to the Backpack Newsletter so you can find out about any security updates, breaking changes or major features. We send an email every 1-2 months., _(*3)

Install

Note: The default table name is settings, if you need to change it please carefully read the comments in the instruction below., _(*4)

In your terminal:, _(*5)

``` bash, _(*6)

install the package

composer require backpack/settings, _(*7)

[optional] if you need to change table name or migration name, please do it now before proceding

php artisan vendor:publish --provider="Backpack\Settings\SettingsServiceProvider" --tag="config", _(*8)

then change the values you need in in `config/backpack/settings.php`

publish & run the migration

php artisan vendor:publish --provider="Backpack\Settings\SettingsServiceProvider" php artisan migrate, _(*9)

For Backpack v6

php artisan backpack:add-menu-content "<:menu-item title="Settings" icon="la la-cog" :link="\"backpack_url('setting')\"">", _(*10)

For Backpack v5 or v4

php artisan backpack:add-sidebar-content ", _(*11)

Settings

[optional] insert some example dummy data to the database

php artisan db:seed --class="Backpack\Settings\database\seeds\SettingsTableSeeder", _(*12)


## Usage

### End user
Add it to the menu or access it by its route: **application/admin/setting**

### Programmer
Use it like you would any config value in a virtual settings.php file. Except the values are stored in the database and fetched on boot, instead of being stored in a file.

``` php
Setting::get('contact_email')
// or
Config::get('settings.contact_email')

Add new settings

Settings are stored in the database in the "settings" table. Its columns are: - id (ex: 1) - key (ex: contact_email) - name (ex: Contact form email address) - description (ex: The email address that all emails go to.) - value (ex: admin@laravelbackpack.com) - field (Backpack CRUD field configuration in JSON format. The "name" of the field is mandatory to be "value") - see the field types and their configuration code on https://backpackforlaravel.com/docs/crud-fields#default-field-types - active (1 or 0) - created_at - updated_at, _(*13)

There is no interface available to add new settings. They are added by the developer directly in the database, since the Backpack CRUD field configuration is a bit complicated. See the field types and their configuration code on https://backpackforlaravel.com/docs, _(*14)

Override existing configurations

You can use this addon to make various Laravel configurations adjustable through the settings GUI, including Backpack settings themself. For example, you can override the Backpack show_powered_by setting in /config/backpack/ui.php., _(*15)

Create the setting entry in your settings database. You can add the settings manually, or via Laravel seeders. The values inserted into the database should be look similar to below:, _(*16)

For Backpack show_powered_by setting:, _(*17)

Field	Value
key	show_powered_by
name	Showed Powered By
description	Whether to show the powered by Backpack on the bottom right corner or not.
value	1
field	{"name":"value","label":"Value","type":"checkbox"}
active	1

NOTE: The field column should be a JSON string. The name key in the JSON string should be value. Using any other key will not work., _(*18)

Open up the app/Providers/AppServiceProvider file, and add the below lines:, _(*19)

```diff <?php, _(*20)

namespace App\Providers;, _(*21)

use Illuminate\Support\ServiceProvider;, _(*22)

class AppServiceProvider extends ServiceProvider { /** * Bootstrap any application services. * * @return void */ public function boot() {, _(*23)
- ```
$this->overrideConfigValues();
```
  }, _(*24)
  
  /**, _(*25)
  - Register any application services.
  - @return void */ public function register() { // }

protected function overrideConfigValues()
{
$config = [];
if (config('settings.show_powered_by')) {
$config['backpack.ui.show_powered_by'] = config('settings.show_powered_by') == '1';
}
config($config);
} } ```

Screenshots

See backpackforlaravel.com, _(*26)

List view:
Editing a setting with the email field type:

Change log

Please see CHANGELOG for more information what has changed recently., _(*27)

Testing

bash $ composer test, _(*28)

Contributing

Please see CONTRIBUTING for details., _(*29)

Overwriting Functionality

If you need to modify how this works in a project: - create a routes/backpack/settings.php file; the package will see that, and load your routes file, instead of the one in the package; - create controllers/models that extend the ones in the package, and use those in your new routes file; - modify anything you'd like in the new controllers/models;, _(*30)

Security

If you discover any security related issues, please email tabacitu@backpackforlaravel.com instead of using the issue tracker., _(*31)

Please subscribe to the Backpack Newsletter so you can find out about any security updates, breaking changes or major features. We send an email every 1-2 months., _(*32)

Credits

License

Backpack is free for non-commercial use and 69 EUR/project for commercial use. Please see License File and backpackforlaravel.com for more information., _(*33)

Hire us

We've spend more than 50.000 hours creating, polishing and maintaining administration panels on Laravel. We've developed e-Commerce, e-Learning, ERPs, social networks, payment gateways and much more. We've worked on admin panels so much, that we've created one of the most popular software in its niche - just from making public what was repetitive in our projects., _(*34)

If you are looking for a developer/team to help you build an admin panel on Laravel, look no further. You'll have a difficult time finding someone with more experience & enthusiasm for this. This is what we do. Contact us. Let's see if we can work together., _(*35)

The Versions

20/04 2018

dev-fix-inactive-settings

dev-fix-inactive-settings https://github.com/laravel-backpack/settings

Application settings interface for Laravel 5 using Backpack CRUD.

library settings

Application settings interface for Laravel 5 using Backpack CRUD.