https://github.com/anisaronno/laravel-settings
A Laravel package for managing application settings, similar to WordPress options.
https://github.com/anisaronno/laravel-settings
application-settings laravel-options laravel-settings
Last synced: 10 months ago
JSON representation
A Laravel package for managing application settings, similar to WordPress options.
- Host: GitHub
- URL: https://github.com/anisaronno/laravel-settings
- Owner: anisAronno
- License: mit
- Created: 2023-10-10T10:30:45.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-18T05:31:25.000Z (about 2 years ago)
- Last Synced: 2025-06-12T22:35:20.970Z (about 1 year ago)
- Topics: application-settings, laravel-options, laravel-settings
- Language: PHP
- Homepage:
- Size: 1.32 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Laravel Settings Package
- Laravel settings control as like as WordPress options
## Table of Contents
- [Laravel Settings Package](#laravel-settings-package)
- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [Installation](#installation)
- [Publish Migration, Factory, Config, and Seeder](#publish-migration-factory-config-and-seeder)
- [Run Migration](#run-migration)
- [Run Seeder](#run-seeder)
- [Usage](#usage)
- [Check if a Key Exists in Database](#check-if-a-key-exists-in-database)
- [Get Settings Field](#get-settings-field)
- [Get All Settings Fields](#get-all-settings-fields)
- [Set Settings](#set-settings)
- [Update Settings](#update-settings)
- [Update or Create Settings](#update-or-create-settings)
- [Delete Settings](#delete-settings)
- [Contribution Guide](#contribution-guide)
- [License](#license)
## Introduction
The Laravel Settings package simplifies the management of application settings in your Laravel project. This README provides installation instructions, usage examples, and additional information.
## Installation
To get started, install the package using Composer:
```shell
composer require anisaronno/laravel-settings
```
### Publish Migration, Factory, Config, and Seeder
You need to publish migration files, factories, configuration files, and a seeder:
```shell
php artisan vendor:publish --tag=settings-migration
```
### Run Migration
Apply the migrations to set up the settings table:
```shell
php artisan migrate
```
### Run Seeder
Seed the settings table with initial data:
```shell
php artisan db:seed --class=LaravelSettingsSeeder::class
```
## Usage
The package provides methods for managing settings. Here are the available functions:
### Check if a Key Exists in Database
You can use the `hasSettings` method to check if a key exists in the database:
```php
hasSettings(string $key);
```
### Get Settings Field
Retrieve a specific setting using its key:
```php
getSettings(string $key);
```
### Get All Settings Fields
Fetch all settings fields:
```php
getAllSettings();
```
### Set Settings
Create or update a setting:
```php
setSettings(string $key, string $value);
```
### Update Settings
Update an existing setting:
```php
updateSettings(string $key, string $value);
```
### Update or Create Settings
Update or Create setting:
```php
upsertSettings(string $key, string $value);
```
### Delete Settings
Update an existing setting:
```php
deleteSettings(string $key);
```
## Contribution Guide
Please follow our [Contribution Guide](https://github.com/anisAronno/multipurpose-admin-panel-boilerplate/blob/develop/CONTRIBUTING.md) if you'd like to contribute to this package.
## License
This package is open-source software licensed under the [MIT License](https://opensource.org/licenses/MIT).