Download the PHP package ngankt2/filament-db-config-encrypt without Composer
On this page you can find all versions of the php package ngankt2/filament-db-config-encrypt. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ngankt2/filament-db-config-encrypt
More information about ngankt2/filament-db-config-encrypt
Files in ngankt2/filament-db-config-encrypt
Package filament-db-config-encrypt
Short Description A Filament plugin for database-backed application settings and editable content, with caching and easy page generation.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package filament-db-config-encrypt
Filament DB Config Encrypt
A Filament plugin for managing database-backed application settings and editable content with caching and encryption support. It provides an Artisan command to generate settings pages and a helper function to retrieve settings in Blade templates or PHP code.
This project is a fork of https://github.com/inerba/filament-db-config. I only retrieved the source code to customize and use it privately, including renaming namespaces and adding several scenarios for encrypting data before storage.
Special thanks to the original author for their great work.
Features
- Database-Backed Settings: Store and manage application settings in a database table.
- Encryption Support: Optionally encrypt settings for enhanced security.
- Caching: Cache settings with configurable TTL for performance optimization.
- Filament Integration: Generate Filament settings pages with a single Artisan command.
- Helper Function: Easily access settings in Blade templates or PHP code using the
db_config()helper. - Flexible Grouping: Organize settings into groups for better management.
- Customizable Views: Support for custom Blade views or a default view for settings pages.
Requirements
- PHP: ^8.2
- Laravel: ^10.0 or ^11.0 or ^12.0
- Filament: ^3.0 or ^4.0
- ngankt2/laravel-helper: ^1.0
Installation
Install the package via Composer:
After installation, publish the configuration file and run the migrations:
This will create a db_config table in your database to store settings.
Configuration
The configuration file is located at config/db-config.php. Below is an example configuration:
table_name: The name of the database table to store settings.encrypt: Set totrueto encrypt settings before storing them in the database.cache.prefix: The prefix for cache keys.cache.ttl: Time-to-live for cached settings in minutes. Set to0to cache indefinitely.
Usage
Generating a Settings Page
Use the provided Artisan command to generate a Filament settings page:
This command will:
- Create a settings page class (e.g.,
app/Filament/Admin/Clusters/SettingsCluster/Pages/GeneralSettings.php). - Optionally create a Blade view if you choose to use a custom view.
- Support clusters for organizing settings pages.
The generated page extends Ngankt2\DbConfig\AbstractPageSettings and includes methods to define the settings group, default data, and form schema.
Defining Settings
Edit the generated settings page to define the form schema and default data. For example:
Accessing Settings
Use the db_config() helper function to retrieve settings in Blade templates or PHP code:
The helper retrieves settings from the db_config table, using the cache if configured. If encryption is enabled, the settings are automatically decrypted.
Saving Settings
The generated settings page includes a "Save" action that persists form data to the database. When the form is submitted, the save() method in AbstractPageSettings stores the data under the specified group and key, with optional merging of existing values.
Customizing the View
When generating a settings page, you can choose to create a custom Blade view. If you opt out, the page uses the default view (db-config::settings-base). To customize the view, specify a custom view path during generation:
Then, edit the generated Blade view (e.g., resources/views/db-config/[panel-id].general-settings.blade.php) to customize the layout.
Database Structure
The db_config table has the following structure:
| Column | Type | Description |
|---|---|---|
group |
string | The settings group (e.g., 'default' or tenant ID). |
key |
string | The settings key (e.g., 'general'). |
settings |
text | The JSON-encoded (and optionally encrypted) settings value. |
created_at |
timestamp | Creation timestamp. |
updated_at |
timestamp | Last update timestamp. |
Advanced Usage
Bypassing Cache
To retrieve settings without using the cache:
Merging Settings
By default, settings are merged with existing values. To override instead of merging, override the getMerge() method in your settings page:
Custom Group Name
To use a different group name for settings, override the groupName() method:
Contributing
Contributions are welcome! Please submit a pull request or open an issue on the GitHub repository.
Support
If you encounter any issues or have questions, please open an issue on the GitHub repository or contact the author at [email protected].
License
This package is open-sourced software licensed under the MIT license.
