Download the PHP package lcharette/uf_configmanager without Composer
On this page you can find all versions of the php package lcharette/uf_configmanager. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download lcharette/uf_configmanager
More information about lcharette/uf_configmanager
Files in lcharette/uf_configmanager
Package uf_configmanager
Short Description This Sprinkle provides a UI for core and custom site settings
License MIT
Homepage https://github.com/lcharette/UF_ConfigManager
Informations about the package uf_configmanager
Configuration Manager Sprinkle for UserFrosting 5
Configuration Manager sprinkle for UserFrosting 5. Lets you edit UserFrosting configs from the interface.
Help and Contributing
If you need help using this sprinkle or found any bug, feels free to open an issue or submit a pull request. You can also find me on the UserFrosting Chat most of the time for direct support.
Installation
To install in your Sprinkle :
-
Add this package with Composer :
-
Edit your Sprinkle Recipe to include the ConfigManager as a Sprinkle dependency :
-
Add Config Manager frontend assets dependencies :
-
Add Config Manager & FormGenerator frontend entries to your webpack entries. Open
webpack.config.js
and add inconst sprinkles { ... }
: - Run :
Working example
The public/
directory serves as an example of ConfigManager. You can clone this repository and install as any UserFrosting 5 sprinkle :
composer install
php bakery bake
php -S localhost:8080 -t public
Permissions
The migration will automatically add the update_site_config
permission to the Site Administrator
role. If it's not added automatically, you can run the UserFrosting\Sprinkle\ConfigManager\Database\Seeds\SettingsPermissions
seed using the php bakery seed
command or add it manually in the admin UI. To give access to the config UI to another user, simply add the update_site_config
permission slug to that user role.
Add link to the menu
The configuration UI is bound to the the /settings
route. Simply add a link to this route where you want it. The checkAccess make it so it will appear only for users having the appropriate permission. For example, you can add the following to the sidebar menu :
Adding custom config
Settings are separated by topics in the UI. Each topic is represented by a file, located in schema/config/
. Unlike normal schema files, all entries needs to be wrapped inside a config
key. A name
and desc
top-level entry will allow to define the title and description of the topic.
For example, to add an entry for site.title
text and site.registration.enabled
checkbox option in a "UserFrosting Settings" topic :
NOTE Only
.json
are accepted.Yaml
schemas are cannot be used for now.
License
By Louis Charette. Copyright (c) 2020, free to use in personal and commercial software as per the MIT license.
All versions of uf_configmanager with dependencies
lcharette/uf_formgenerator Version ~5.1.0
userfrosting/framework Version ~5.1.0
userfrosting/sprinkle-core Version ~5.1.0
userfrosting/sprinkle-account Version ~5.1.0
userfrosting/sprinkle-admin Version ~5.1.0
userfrosting/theme-adminlte Version ~5.1.0