koel/app/Models/Setting.php

69 lines
1.5 KiB
PHP
Raw Normal View History

2015-12-13 04:42:28 +00:00
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Factories\HasFactory;
2015-12-13 04:42:28 +00:00
use Illuminate\Database\Eloquent\Model;
/**
* @property string $key
2021-06-05 10:47:56 +00:00
* @property mixed $value
2019-08-05 10:57:36 +00:00
*
2019-08-05 10:56:48 +00:00
* @method static self find(string $key)
* @method static self updateOrCreate(array $where, array $params)
*/
2015-12-13 04:42:28 +00:00
class Setting extends Model
{
use HasFactory;
2015-12-13 04:42:28 +00:00
protected $primaryKey = 'key';
2015-12-13 04:42:28 +00:00
public $timestamps = false;
protected $guarded = [];
/**
* Get a setting value.
*/
2021-06-05 10:47:56 +00:00
public static function get(string $key) // @phpcs:ignore
2015-12-13 04:42:28 +00:00
{
2020-12-22 20:11:22 +00:00
$record = self::find($key);
2015-12-13 04:42:28 +00:00
2021-06-05 10:47:56 +00:00
return $record ? $record->value : null;
2015-12-13 04:42:28 +00:00
}
/**
* Set a setting (no pun) value.
*
2021-06-05 10:47:56 +00:00
* @param string|array $key the key of the setting, or an associative array of settings,
2020-09-06 21:20:42 +00:00
* in which case $value will be discarded
2015-12-13 04:42:28 +00:00
*/
2018-08-24 15:27:19 +00:00
public static function set($key, $value = null): void
2015-12-13 04:42:28 +00:00
{
if (is_array($key)) {
foreach ($key as $k => $v) {
self::set($k, $v);
}
return;
}
self::updateOrCreate(compact('key'), compact('value'));
}
/**
* Serialize the setting value before saving into the database.
* This makes settings more flexible.
*/
2018-08-24 15:27:19 +00:00
public function setValueAttribute($value): void
2015-12-13 04:42:28 +00:00
{
$this->attributes['value'] = serialize($value);
}
2017-08-05 16:32:16 +00:00
/**
* Get the unserialized setting value.
*/
2021-06-05 10:47:56 +00:00
public function getValueAttribute($value) // @phpcs:ignore
2015-12-13 04:42:28 +00:00
{
return unserialize($value);
}
}