koel/app/Models/Setting.php

81 lines
1.7 KiB
PHP
Raw Normal View History

2015-12-13 12:42:28 +08:00
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
/**
* @property string $key
* @property mixed $value
2019-08-05 17:57:36 +07:00
*
2019-08-05 17:56:48 +07:00
* @method static self find(string $key)
* @method static self updateOrCreate(array $where, array $params)
*/
2015-12-13 12:42:28 +08:00
class Setting extends Model
{
protected $primaryKey = 'key';
public $timestamps = false;
protected $guarded = [];
/**
* Get a setting value.
*
* @param string $key
*
2018-08-24 17:27:19 +02:00
* @return mixed|string
2015-12-13 12:42:28 +08:00
*/
2018-08-24 17:27:19 +02:00
public static function get(string $key)
2015-12-13 12:42:28 +08:00
{
if ($record = self::find($key)) {
return $record->value;
}
2020-06-07 22:43:04 +02:00
return null;
2015-12-13 12:42:28 +08:00
}
/**
* Set a setting (no pun) value.
*
* @param string|array $key The key of the setting, or an associative array of settings,
* in which case $value will be discarded.
2015-12-14 08:22:39 -05:00
* @param mixed $value
2015-12-13 12:42:28 +08:00
*/
2018-08-24 17:27:19 +02:00
public static function set($key, $value = null): void
2015-12-13 12:42:28 +08: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.
*
* @param mixed $value
*/
2018-08-24 17:27:19 +02:00
public function setValueAttribute($value): void
2015-12-13 12:42:28 +08:00
{
$this->attributes['value'] = serialize($value);
}
2017-08-05 17:32:16 +01:00
/**
* Get the unserialized setting value.
*
* @param mixed $value
*
* @return mixed
*/
2015-12-13 12:42:28 +08:00
public function getValueAttribute($value)
{
return unserialize($value);
}
}