Easy Config / Settings save and read class with caching PHP/Laravel

 

 

Photo by Emile Perron on Unsplash  

 

Commonly most web applications require save configs and settings . there are many ways and methods to save and retrieve configs and settings. today i will share with you my method to save and retrieve settings data in laravel application.

 

Create migration and and Model

php artisan make:model Settings -m


in your migration file: add these fields:

public function up()
{
Schema::create('settings', function (Blueprint $table) {
$table->id();
$table->string('key');
$table->string('value');
$table->unsignedBigInteger('updated_user')->nullable();
$table->timestamps();
});
}

use 'updated_user' to track who changed value last time.

you can also use 'text' or any suitable type to 'value' field I used string(varchar255) here.


DB Model class

<?php

namespace App\Models;


use Illuminate\Database\Eloquent\Model;

class Settings extends Model
{
//Make fillable all fields except id
protected $guarded = ['id'];
}


Settings service

<?php

namespace App\Classes;
// your namespace. you can change it to your related namespace.

use Illuminate\Support\Facades\Cache;
use App\Models\Settings;

class SettingsService
{
public const CACHED_TIME = 60 * 60 * 24; //cache time day
//key prefix for cache retrive not mandetory
const KEY_PRFX = "settings.";

/** set setting value */

public static function setVal($key, $value)
{
Cache::forget(self::KEY_PRFX . $key);

return Settings::updateOrCreate(
[
'key' => $key,
],
[
'value' => $value,
'updated_user' => auth()->id() ?? null
]
);
}


/** get setting value */
public static function getVal($key, $default_value = null, $cached = true)
{
//create a function so its easy to inject to cache method
$readValFunc = function () use ($key, $default_value) {
$seting = Settings::where('key', $key)->first();
return data_get($seting, 'value', $default_value);
};


//check is cached value or current value
if ($cached) {
return self::cached($key, $readValFunc);
}

return $readValFunc();
}


/** cache the setting value */
private static function cached($key, callable $func)
{
return Cache::remember(self::KEY_PRFX . $key, self::CACHED_TIME, $func);
}
}



You can now use just importing class to any controller or any class, but let make more easy accessing by registering to app container

Registering class

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use App\Classes\SettingsService;
class AppServiceProvider extends ServiceProvider
{
/**
* Register any application services.
*
* @return void
*/
public function register()
{
}

/**
* Bootstrap any application services.
*
* @return void
*/
public function boot()
{
        
$this->app->singleton('Settings', function($app) {
return new SettingsService();
});
}
}


in your app service provider file, just import class, and add singleton service to boot function. 

now clear class cached data using

php artisan optimize:clear

(if class not registered try running also composer dump-autoload)


now we can use like bellow


//set value
app('Settings')->setVal('your_settings.key', 'value');
//get value
app('Settings')->getVal('your_settings.key', 'default_value');
 

that it :D . thanks for reading!.  if you found any mistakes please comment.

 



Comments

Post a Comment

Popular posts from this blog

How to use Spatie packages to enhance your Laravel development experience

Image
Spatie is a company(https://spatie.be)  that creates open source packages for Laravel, PHP and JavaScript. Spatie packages are useful for Laravel development because they provide solutions for common problems and tasks, such as managing user permissions and roles, backing up your app, transforming data for APIs, manipulating images and more. Spatie packages are easy to use, well documented and tested. You can find a list of Spatie packages on their website or on their GitHub page also . as a laravel developer i have using their packages for various tasks and fetures, they are really useful and life saving of the developer. Some of their most popular packages are laravel-permission,activity lo, laravel-backup, laravel-medialibrary.     < 1.      Laravel-Permission   One of the essential aspects of web application development is managing user permissions and roles. Laravel-Permission is a Spatie package that simplifies this process by prov...
Read more

Handling undefined variables in laravel

Handling undefined variables in your laravel code is critically important because it can help prevent errors and improve the stability of your program. Undefined or null variables occur when you try to access a variable that has not been declared or assigned a value. If you try to use an undefined variable in your code, it can cause errors that can break your program or produce incorrect results. By handling undefined variables correctly in your laravel project, you can ensure that your program runs smoothly and produces the desired results in production. There are several ways to handle undefined variables, such as checking for their existence before using them, setting default values,  using type coercion, or using try-catch blocks to handle errors.   the try catch is a great way to achieve error handling. its better to wrap  your controller route connected methods with try-catch block. but when a handling small variable the try catch block not always great. here some...
Read more

Some Briefs of Data Mining

Image
I am currently learning data mining and I thought of sharing some interesting facts I have learned from my notes. I hope these facts will be useful for those who are interested in data mining :)                 Why data mining is required?    Data mining is required because it helps us to extract useful information and insights from large amounts of data. With the growth of technology, we are generating more data than ever before, and this data can be used to make better decisions, improve business operations, and gain a competitive advantage. Data mining techniques can help us to identify patterns, relationships, and trends in the data that may not be immediately apparent. By analyzing this data, we can gain insights into customer behavior, market trends, and other important factors that can help us to make better decisions. Data mining is used in many different fields, including finance, healthcare, m...
Read more