1
0
mirror of https://github.com/flarum/core.git synced 2025-08-03 23:17:43 +02:00

Implement user preferences API

Preferences must be registered (optionally with a callback to transform
data, and a default value) on the User model.
This commit is contained in:
Toby Zerner
2015-03-28 11:50:02 +10:30
parent 3c3f8242e2
commit 359f44552e
6 changed files with 61 additions and 1 deletions

View File

@@ -61,6 +61,8 @@ class User extends Model
*/
protected static $hasher;
protected static $preferences = [];
/**
* Raise an event when a post is deleted.
*
@@ -346,6 +348,52 @@ class User extends Model
return $this->notifications()->where('time', '>', $this->notification_read_time ?: 0)->where('is_read', 0)->count(\DB::raw('DISTINCT type, subject_id'));
}
public function getPreferencesAttribute($value)
{
$defaults = [];
foreach (static::$preferences as $k => $v) {
$defaults[$k] = $v['default'];
}
return array_merge($defaults, (array) json_decode($value, true));
}
public function setPreferencesAttribute($value)
{
$this->attributes['preferences'] = json_encode($value);
}
public static function registerPreference($key, $transformer = null, $default = null)
{
static::$preferences[$key] = [
'transformer' => $transformer,
'default' => $default
];
}
public function preference($key, $default = null)
{
return array_get($this->preferences, $key, $default);
}
public function setPreference($key, $value)
{
if (isset(static::$preferences[$key])) {
$preferences = $this->preferences;
if (! is_null($transformer = static::$preferences[$key]['transformer'])) {
$preferences[$key] = call_user_func($transformer, $value);
} else {
$preferences[$key] = $value;
}
$this->preferences = $preferences;
}
return $this;
}
/**
* Check whether or not the user is an administrator.
*