Download the PHP package hankz/laravel-system-settings without Composer
On this page you can find all versions of the php package hankz/laravel-system-settings. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download hankz/laravel-system-settings
More information about hankz/laravel-system-settings
Files in hankz/laravel-system-settings
Download hankz/laravel-system-settings
More information about hankz/laravel-system-settings
Files in hankz/laravel-system-settings
Vendor hankz
Package laravel-system-settings
Short Description A Laravel package designed for managing system configuration values in database.
License MIT
Package laravel-system-settings
Short Description A Laravel package designed for managing system configuration values in database.
License MIT
FAQ
After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.
Example:
Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.
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.
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 PHP packages are not free to download and because of that hosted in private repositories.
In this case some credentials are needed to access such packages.
Please use the auth.json textarea to insert credentials, if a package is coming from a private repository.
You can look here for more information.
- 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.
Please rate this library. Is it a good library?
Informations about the package laravel-system-settings
English Document | 繁體中文文件
Laravel System Settings
A Laravel package designed for managing system configuration values in database.
Installation
1. Composer install
Run the Composer require command from the Terminal:
2. Setup
This package supports Laravel's auto-discovery feature and it's ready to use once installed.
3. Publishing the config file
You need publish the config file.
4. Configuration
You can configure this package in config\system-settings.php
- table_name - Save the system settings table name in the database.
- default.group - The default group name when you are missing the group parameter.
5. Migration
You should also run the migrate command.
Usage
This package is very simple and provides the following methods for your use.
new(string $key, string $value, string $group = null, string $description = null): bool
Create a new system setting.
Parameters:
$key(string): The unique identifier for the system setting.$value(string): The value associated with the system setting.$group(string|null): (Optional) The group to which the system setting belongs. Default isnull.$description(string|null): (Optional) A description providing additional information about the system setting. Default isnull.
Example:
Returns:
bool: Returnstrueif the system setting is created successfully, or throws aSystemSettingAlreadyExistsExceptionif the setting already exists.
has(string $key, string $group = null): bool
The has() method checks if a system setting exists with the given key and optional group.
Parameters:
$key(string): The unique identifier for the system setting.$group(string|null): (Optional) The group to which the system setting belongs. Default isnull.
Example:
Returns:
bool: Returnstrueif the system setting exists, otherwisefalse.
all(): array
Return all system settings with key and value in the format of key-value pairs.
Example:
Returns:
array: An associative array containing all system settings in the format['key' => 'value'].
get(string $key, string $group = null, string $default = null): null|string
The get() method allows you to retrieve the value using both the key name and group name, and it also accepts a default value.
Parameters:
$key(string): The unique identifier for the system setting.$group(string|null): (Optional) The group to which the system setting belongs. Default isnull.$default(string|null): (Optional) The default value to return if the system setting is not found. Default isnull.
Example:
Returns:
string|null: Returns the value of the system setting if found, otherwise returns the specified default value ornullif no default is provided.
set(string $key, string $value, string $group = null, string $description = null, bool $createWhenNotExist = false): void
The set() method allows you to update the value and description of an existing system setting or create a new one if it does not exist.
Parameters:
$key(string): The unique identifier for the system setting.$value(string): The new value to set for the system setting.$group(string|null): (Optional) The group to which the system setting belongs. Default isnull.$description(string|null): (Optional) A description providing additional information about the system setting. Default isnull.$createWhenNotExist(bool): (Optional) If set totrue, a new system setting will be created if the specified key does not exist. Default isfalse.
Example:
Returns:
void
getByGroup(string $group): array
Retrieve all system settings within a specified group.
Parameters:
$group(string): The group from which to retrieve system settings.
Example:
Returns:
array: An associative array containing system settings within the specified group in the format['key' => 'value'].
setByGroup(array $settings, string $group = null, bool $createWhenNotExist = false): void
Update or create multiple system settings within a specified group.
Parameters:
$settings(array): An associative array containing system settings in the format['key' => ['value' => '', 'description' => '']].$group(string|null): (Optional) The group to which the system settings belong. Default isnull.$createWhenNotExist(bool): (Optional) If set totrue, new system settings will be created for keys that do not exist in the specified group. Default isfalse.
Example:
Returns:
void
delete(string $key, string $group = null): bool|null
Delete a system setting with the specified key and optional group.
Parameters:
$key(string): The unique identifier for the system setting.$group(string|null): (Optional) The group to which the system setting belongs. Default isnull.
Example:
Returns:
bool|null: Returnstrueif the system setting is successfully deleted,falseif the setting does not exist, ornullif an error occurs.
To-do list
- Add audit log
License
MIT License © 2023 Hankz
All versions of laravel-system-settings with dependencies
PHP Build Version
Package Version
The package hankz/laravel-system-settings contains the following files
Loading the files please wait ....