Download the PHP package venom/system-settings without Composer
On this page you can find all versions of the php package venom/system-settings. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download venom/system-settings
More information about venom/system-settings
Files in venom/system-settings
Package system-settings
Short Description A laravel module that will handle system settings for your application.
License MIT
Informations about the package system-settings
Venom System Settings Package
The Venom System Settings package allows you to manage application settings dynamically in a Laravel application. This package provides an easy way to store, retrieve, and manage key-value pairs, with support for various data types.
Features
- Dynamic Settings Management: Store and retrieve application settings dynamically.
- Caching: Improve performance by caching settings.
- Type Management: Support for different data types such as strings, integers, booleans, and JSON.
- Extendable: Easily extend the base model to add custom logic or relationships.
- Commands: Manage settings through Artisan commands.
Installation
You can install the package via Composer:
Publish Configuration & Migrations
After installation, publish the configuration and migration files:
Run the migrations to create the necessary tables:
Configuration
The configuration file (config/system_settings.php) includes various options:
- cache_duration: The duration in minutes for caching settings.
- allowed_types: The allowed data types for settings.
- model: The model class used for storing settings. You can extend or replace the default model.
- cache_key_prefix: A prefix for the cache keys used in storing settings.
- default_type: The default type used when none is provided.
Usage
Retrieving a Setting
You can retrieve a setting using the get method:
Setting a Value
To set or update a setting's value:
Deleting a Setting
To delete a setting by its key
Bulk Actions
Retrieve all settings or filter by type:
Artisan Commands
The package provides several Artisan commands:
-
Set a Setting: Set or update a setting using the command line.
-
Get a Setting: Retrieve a setting value by key.
-
Check if a Setting Exists: Check if a setting exists by key.
- Clear Cached Settings: Clear the cached settings.
Extending the Package
You can extend the package by creating your own model that inherits from the base model:
Update the configuration file to use your custom model:
Contributing
Contributions are welcome! Please submit pull requests or open issues to discuss potential improvements.
License
The Venom System Settings package is open-source software licensed under the MIT license.
Key Sections:
- Introduction: Overview of the package and its features.
- Installation: Step-by-step guide to installing and setting up the package.
- Configuration: Details on configuring the package according to your needs.
- Usage: Examples of how to use the package to manage settings.
- Extending the Package: Instructions for extending the package with custom models.
- Contributing: Information on how to contribute to the project.
- License: License information for the package.
This README.md
provides clear and comprehensive documentation for users of your package.
All versions of system-settings with dependencies
illuminate/database Version ^11.21.0
illuminate/queue Version ^11.21
illuminate/bus Version ^11.21
illuminate/contracts Version ^11.21