Documentation

config extends dataset
in package
implements isObjectInstancable Uses eventModuleEmpty

System config Objekt

Tags
author

Stefan Seehafer sea75300@yahoo.de

copyright

(c) 2011-2021, Stefan Seehafer

license

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

Interfaces, Classes, Traits and Enums

isObjectInstancable
Interface for objects with build in cache loader

Table of Contents

$article_template_active  : string
$articles_acp_limit  : int
$articles_archive_datelimit  : int
$articles_archive_show  : bool
$articles_limit  : int
$articles_link_urlrewrite  : bool
$articles_revisions  : bool
$articles_revisions_limit  : int
$articles_rss  : bool
$articles_sort  : string
$articles_sort_order  : string
$articles_template_active  : string
$comments_antispam_answer  : string
$comments_antispam_question  : string
$comments_confirm  : bool
$comments_default_active  : bool
$comments_email_optional  : bool
$comments_flood  : int
$comments_markspam_commentcount  : int
$comments_notify  : int
$comments_privacy_optin  : bool
$comments_template_active  : string
$file_cropper_name  : string
$file_list_limit  : int
$file_subfolders  : bool
$file_thumb_size  : int
$file_view  : string
$smtp_enabled  : bool
$smtp_settings  : smtpSettings
$system_2fa_auth  : bool
$system_cache_timeout  : int
$system_comments_enabled  : bool
$system_css_path  : string
$system_darkmode  : bool
$system_dtmask  : string
$system_editor  : bool
$system_editor_fontsize  : int
$system_email  : string
$system_lang  : string
$system_loader_jquery  : bool
$system_loginfailed_locked  : int
$system_maintenance  : bool
$system_mode  : bool
$system_passcheck_enabled  : bool
$system_share_count  : bool
$system_show_share  : bool
$system_timezone  : string
$system_trash_cleanup  : int
$system_updates_devcheck  : int
$system_updates_emailnotify  : bool
$system_updates_manual  : int
$system_url  : string
$system_version  : string
$twitter_data  : twitterSettings
$twitter_events  : twitterEvents
$cache  : cache
System-Cache
$cacheName  : string
Cache name
$config  : config
System-Config-Objekt
$data  : array<string|int, mixed>
data-Array für nicht weiter definierte Eigenschaften
$dbcon  : database
DB-Verbindung
$dbExcludes  : array<string|int, mixed>
Eigenschaften, welche beim Speichern in DB nicht von getPreparedSaveParams() zurückgegeben werden sollen
$editAction  : string
Controller-Pfad, wenn Objekt Edit-Action besitzt
$events  : events
Event-Liste
$id  : int
Objekt-ID
$language  : language
System-Sprachen-Objekt
$newConfig  : array<string|int, mixed>
Neue Konfiguration
$nodata  : bool
$this->data beim Speichern nicht berücksichtigen
$notifications  : notifications
Notifications
$objExists  : bool
Objektexistiert
$session  : session
System-Session
$table  : string
Tabellen-Name
$userConfigSet  : bool
Benuter-Config bereits eingelesen
__construct()  : bool
Konstruktor
__destruct()  : void
Konstruktor
__get()  : mixed
Magic get
__set()  : mixed
Magic set
__toString()  : string
Magic string
add()  : bool
Neuen Config-Key erzeugen
createFromDbObject()  : bool
Füllt Objekt mit Daten aus Datenbank-Result
delete()  : bool
not used
disableTwitter()  : bool
Disables Twitter connection
exists()  : bool
Prüft ob Objekt existiert
getAcpArticleLimits()  : array<string|int, mixed>
Array mit Anzahl-Limits für Artikel in ACP-Liste
getArticleLimits()  : array<string|int, mixed>
Array mit Anzahl-Limits für Artikel-Listen
getData()  : array<string|int, mixed>
Gibt Inhalt von "data" zurück
getDefaultFontsizes()  : array<string|int, mixed>
Array mit Schriftgrößen für Editor
getEditLink()  : string
Gibt Link für Edit-Action zurück
getId()  : int
Gibt Object-ID zurück
getInstance()  : config
Returns config class instance
getModuleOptions()  : array<string|int, mixed>
Returns config options by module key
getNodata()  : bool
Prüft, ob "data" gespeichert werden soll
getPreparedValueParams()  : int
Gibt array mit Values für Prepared Statements zurück
getVersionNumberString()  : string
Returns minor version string as Number
init()  : bool
Inittiert Objekt mit Daten aus der Datenbank
prepareDataSave()  : bool
Bereitet Daten für Speicherung in Datenbank vor
remove()  : bool
Config Key löschen
save()  : bool
not used
setId()  : mixed
Set dataset id
setMaintenanceMode()  : bool
Wartungsmodus aktivieren
setNewConfig()  : mixed
Speichert neue Konfiguration
setNodata()  : mixed
Möglichkeit, "data"-Eigenschaft mit an Datenbank zu senden
setUserSettings()  : bool
Überschreibt systemweite Einstellungen mit Benutzer-Einstellungen
update()  : bool
Konfiguration aktualisieren
afterSaveInternal()  : bool
Is triggered after successful database insert
afterUpdateInternal()  : bool
Is triggered after successful database update
getEventModule()  : string
Returns event base string
getEventName()  : string
Returns full event name string
getPreparedSaveParams()  : array<string|int, mixed>
Bereitet Eigenschaften des Objects zum Speichern ind er Datenbank vor und entfernt nicht speicherbare Eigenschaften
refresh()  : mixed
Config-Refresh

Properties

$article_template_active

public string $article_template_active

Active single article view template

$articles_acp_limit

public int $articles_acp_limit

Number of articles per page in ACP

$articles_archive_datelimit

public int $articles_archive_datelimit

Hide articles before this date in frontend archive

$articles_archive_show

public bool $articles_archive_show

Show article archive in frontend

$articles_limit

public int $articles_limit

Number of articles per page in frontend

public bool $articles_link_urlrewrite

Enable URL-Rewriting (ID and article will be included within article link)

$articles_revisions

public bool $articles_revisions

Enable revision system for articles

$articles_revisions_limit

public int $articles_revisions_limit

Maximum number of kept articles revision

$articles_rss

public bool $articles_rss

Enable RSS feed

$articles_sort

public string $articles_sort

Sort by field in frontend

$articles_sort_order

public string $articles_sort_order

Sort order in frontend

$articles_template_active

public string $articles_template_active

Active article list template

$comments_antispam_answer

public string $comments_antispam_answer

Anti spam captcha reply

$comments_antispam_question

public string $comments_antispam_question

Anti spam captcha question

$comments_confirm

public bool $comments_confirm

Comments need to be approved before

$comments_default_active

public bool $comments_default_active

Set comments enabled by default for articles

$comments_email_optional

public bool $comments_email_optional

E-mail-address is not mandatory for comments

$comments_flood

public int $comments_flood

Flood protection between two comments

$comments_markspam_commentcount

public int $comments_markspam_commentcount

Mark comments as spam, in case the author has been flagged as spammed before

$comments_notify

public int $comments_notify

Send notification for new comments to: 0 = General e-mail address, 1 = article auhor, 2 = both)

$comments_privacy_optin

public bool $comments_privacy_optin

GDPR privacy opt-in

$comments_template_active

public string $comments_template_active

Active comment template

$file_cropper_name

public string $file_cropper_name

Image editor file name

$file_list_limit

public int $file_list_limit

Nubmer of files per page

$file_subfolders

public bool $file_subfolders

Create subfolder of form YYYY-MM

$file_thumb_size

public int $file_thumb_size

Thumbnail size

$file_view

public string $file_view

File manager view

$smtp_enabled

public bool $smtp_enabled

E-mail-submission via SMTP server

$system_2fa_auth

public bool $system_2fa_auth

Two factor authentication enabled

$system_cache_timeout

public int $system_cache_timeout

System cache timeout

$system_comments_enabled

public bool $system_comments_enabled

Comment system enabled

$system_css_path

public string $system_css_path

External CSS file path

$system_darkmode

public bool $system_darkmode

Dark mode enabled on default for all users

$system_dtmask

public string $system_dtmask

Date time mask

$system_editor

public bool $system_editor

article and comment editor

$system_editor_fontsize

public int $system_editor_fontsize

Default editor fontsize

$system_email

public string $system_email

General e-mail address

$system_lang

public string $system_lang

System language

$system_loader_jquery

public bool $system_loader_jquery

Load jquery in frontend

$system_loginfailed_locked

public int $system_loginfailed_locked

Amout of failed logings before account is locked

$system_maintenance

public bool $system_maintenance

Maintenance mode active

$system_mode

public bool $system_mode

Frontend mode (0 = iframe, 1= phpinclude)

$system_passcheck_enabled

public bool $system_passcheck_enabled

Password check enabled

$system_share_count

public bool $system_share_count

Count share button clicks

$system_show_share

public bool $system_show_share

Enable share buttons

$system_timezone

public string $system_timezone

System timezone

$system_trash_cleanup

public int $system_trash_cleanup

Age of datasets in trash to cleanup

$system_updates_devcheck

public int $system_updates_devcheck

Check developer version on update check

$system_updates_emailnotify

public bool $system_updates_emailnotify

E-mail notification if update is available

$system_updates_manual

public int $system_updates_manual

Update check interval for manual update check

$system_url

public string $system_url

Frontend url

$system_version

public string $system_version

System version

$cacheName

Cache name

protected string $cacheName = false

$data

data-Array für nicht weiter definierte Eigenschaften

protected array<string|int, mixed> $data = []

$dbExcludes

Eigenschaften, welche beim Speichern in DB nicht von getPreparedSaveParams() zurückgegeben werden sollen

protected array<string|int, mixed> $dbExcludes = []

$editAction

Controller-Pfad, wenn Objekt Edit-Action besitzt

protected string $editAction

$newConfig

Neue Konfiguration

protected array<string|int, mixed> $newConfig = []

$nodata

$this->data beim Speichern nicht berücksichtigen

protected bool $nodata = true

$objExists

Objektexistiert

protected bool $objExists = false

$table

Tabellen-Name

protected string $table

$userConfigSet

Benuter-Config bereits eingelesen

protected bool $userConfigSet = false

Methods

__construct()

Konstruktor

public __construct() : bool
Return values
bool

__destruct()

Konstruktor

public __destruct() : void
Return values
void

__get()

Magic get

public __get(string $name) : mixed
Parameters
$name : string
Return values
mixed

__set()

Magic set

public __set(mixed $name, mixed $value) : mixed
Parameters
$name : mixed
$value : mixed
Return values
mixed

__toString()

Magic string

public __toString() : string
Return values
string

add()

Neuen Config-Key erzeugen

public add(string $keyname, string $keyvalue[, string $modulekey = '' ]) : bool
Parameters
$keyname : string

Config option name

$keyvalue : string

Config option value

$modulekey : string = ''

Module key

Return values
bool

createFromDbObject()

Füllt Objekt mit Daten aus Datenbank-Result

public createFromDbObject(object $object) : bool
Parameters
$object : object
Return values
bool

delete()

not used

public delete() : bool
Return values
bool

disableTwitter()

Disables Twitter connection

public final disableTwitter() : bool
Tags
since
4.5-rc2
Return values
bool

exists()

Prüft ob Objekt existiert

public exists() : bool
Return values
bool

getAcpArticleLimits()

Array mit Anzahl-Limits für Artikel in ACP-Liste

public static getAcpArticleLimits() : array<string|int, mixed>
Tags
since
3.4
Return values
array<string|int, mixed>

getArticleLimits()

Array mit Anzahl-Limits für Artikel-Listen

public static getArticleLimits() : array<string|int, mixed>
Tags
since
3.4
Return values
array<string|int, mixed>

getData()

Gibt Inhalt von "data" zurück

public getData() : array<string|int, mixed>
Return values
array<string|int, mixed>

getDefaultFontsizes()

Array mit Schriftgrößen für Editor

public static getDefaultFontsizes() : array<string|int, mixed>
Tags
since
3.4
Return values
array<string|int, mixed>

Gibt Link für Edit-Action zurück

public getEditLink() : string
Return values
string

getId()

Gibt Object-ID zurück

public getId() : int
Return values
int

getInstance()

Returns config class instance

public static getInstance() : config
Tags
since
5.1-dev
Return values
config

getModuleOptions()

Returns config options by module key

public getModuleOptions(string $key) : array<string|int, mixed>
Parameters
$key : string
Tags
since
4
Return values
array<string|int, mixed>

getNodata()

Prüft, ob "data" gespeichert werden soll

public getNodata() : bool
Return values
bool

getPreparedValueParams()

Gibt array mit Values für Prepared Statements zurück

public getPreparedValueParams([int $count = false ]) : int
Parameters
$count : int = false
Return values
int

getVersionNumberString()

Returns minor version string as Number

public getVersionNumberString() : string
Tags
since
4.1
Return values
string

init()

Inittiert Objekt mit Daten aus der Datenbank

public init() : bool
Return values
bool

prepareDataSave()

Bereitet Daten für Speicherung in Datenbank vor

public prepareDataSave() : bool
Tags
since
3.6
Return values
bool

remove()

Config Key löschen

public remove(string $keyname) : bool
Parameters
$keyname : string

Config option name

Return values
bool

save()

not used

public save() : bool
Return values
bool

setId()

Set dataset id

public setId(int $id) : mixed
Parameters
$id : int
Return values
mixed

setMaintenanceMode()

Wartungsmodus aktivieren

public setMaintenanceMode(bool $mode) : bool
Parameters
$mode : bool
Return values
bool

setNewConfig()

Speichert neue Konfiguration

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

setNodata()

Möglichkeit, "data"-Eigenschaft mit an Datenbank zu senden

public setNodata(bool $nodata) : mixed
Parameters
$nodata : bool
Return values
mixed

setUserSettings()

Überschreibt systemweite Einstellungen mit Benutzer-Einstellungen

public setUserSettings() : bool
Return values
bool

update()

Konfiguration aktualisieren

public update() : bool
Return values
bool

afterSaveInternal()

Is triggered after successful database insert

protected afterSaveInternal() : bool
Tags
since
4.1
Return values
bool

afterUpdateInternal()

Is triggered after successful database update

protected afterUpdateInternal() : bool
Tags
since
4.1
Return values
bool

getEventModule()

Returns event base string

protected abstract getEventModule() : string
Tags
since
4.1
Return values
string

getEventName()

Returns full event name string

protected final getEventName(string $event) : string
Parameters
$event : string
Tags
since
4.1
Return values
string

getPreparedSaveParams()

Bereitet Eigenschaften des Objects zum Speichern ind er Datenbank vor und entfernt nicht speicherbare Eigenschaften

protected getPreparedSaveParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

refresh()

Config-Refresh

private refresh() : mixed
Return values
mixed

Search results