Documentation

usrmeta extends staticModel
in package
implements ArrayAccess, JsonSerializable, hasPersistence

User settings mnodel

Tags
author

Stefan Seehafer aka imagine fanpress@nobody-knows.org

copyright

(c) 2022, Stefan Seehafer

license

http://www.gnu.org/licenses/gpl.txt GPLv3

since
5.1-dev

Interfaces, Classes, Traits and Enums

ArrayAccess
JsonSerializable
hasPersistence
Interface to store objects as persitent data

Table of Contents

$articles_acp_limit  : int
$backdrop  : string
$dashboard_containers_disabled  : array<string|int, mixed>
$dashboardpos  : array<string|int, mixed>
$file_list_limit  : int
$file_view  : string
$system_darkmode  : bool
$system_dtmask  : string
$system_editor_fontsize  : int
$system_lang  : string
$system_timezone  : string
$cache  : cache
Cache object
$cacheModule  : string
Cache Modul
$cacheName  : string
Cache name
$config  : config
Config object
$data  : array<string|int, mixed>
Data array
$events  : events
Event list
$language  : language
Sprachobjekt
$notifications  : notifications
Notifications
$permissions  : permissions
Permissions
$session  : session
Session objekt
__construct()  : void
Konstruktor
getCacheName()  : string
Cache-Name zurückgeben
getPersistentData()  : int|string
Return persitence data to store in database
jsonSerialize()  : mixed
Returns data for json serialization
mergeData()  : mixed
mergeToConfig()  : void
offsetExists()  : bool
Check is offset exists
offsetGet()  : mixed
Get offset value
offsetSet()  : void
Set value for offset
offsetUnset()  : void
Unset offset => not in use!
resetSettings()  : bool
Reset profile settings
initDefaults()  : void
Init default user meta settings from config

Properties

$articles_acp_limit

public int $articles_acp_limit

Number of articles per page in ACP

$backdrop

public string $backdrop

Backdrop image

$dashboard_containers_disabled

public array<string|int, mixed> $dashboard_containers_disabled

Disabled dashboard container

$dashboardpos

public array<string|int, mixed> $dashboardpos

Dashboard container positions

$file_list_limit

public int $file_list_limit

Nubmer of files per page

$file_view

public string $file_view

File manager view

$system_darkmode

public bool $system_darkmode

Dark mode

$system_dtmask

public string $system_dtmask

Date time mask

$system_editor_fontsize

public int $system_editor_fontsize

Default editor fontsize

$system_lang

public string $system_lang

System language

$system_timezone

public string $system_timezone

System timezone

$cacheModule

Cache Modul

protected string $cacheModule = ''
Tags
since
3.4

$cacheName

Cache name

protected string $cacheName = false

$data

Data array

protected array<string|int, mixed> $data

Methods

__construct()

Konstruktor

public __construct(string|array<string|int, mixed> $data) : void
Parameters
$data : string|array<string|int, mixed>
Return values
void

getCacheName()

Cache-Name zurückgeben

public getCacheName([string $addName = '' ]) : string
Parameters
$addName : string = ''
Return values
string

getPersistentData()

Return persitence data to store in database

public getPersistentData() : int|string
Return values
int|string

jsonSerialize()

Returns data for json serialization

public jsonSerialize() : mixed
Return values
mixed

mergeData()

public mergeData(array<string|int, mixed> $newData) : mixed
Parameters
$newData : array<string|int, mixed>
Return values
mixed

mergeToConfig()

public mergeToConfig(array<string|int, mixed> &$newData) : void
Parameters
$newData : array<string|int, mixed>
Return values
void

offsetExists()

Check is offset exists

public offsetExists(mixed $offset) : bool
Parameters
$offset : mixed
Return values
bool

offsetGet()

Get offset value

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed

offsetSet()

Set value for offset

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed
$value : mixed
Return values
void

offsetUnset()

Unset offset => not in use!

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed
Return values
void

resetSettings()

Reset profile settings

public resetSettings() : bool
Return values
bool

initDefaults()

Init default user meta settings from config

private initDefaults() : void
Return values
void

Search results