Documentation

Config

in package

• SMF

Handles loading and saving SMF's settings, both in Settings.php and database.

Table of Contents

Properties

$backward_compatibility  : int

$boarddir  : string

$boardurl  : string

$cache_accelerator  : string

$cache_enable  : int

$cache_memcached  : string

$cachedir  : string

$cachedir_sqlite  : string

$cookiename  : string

$custom  : array<string|int, mixed>

$db_character_set  : string

$db_error_send  : bool

$db_last_error  : int

$db_mb4  : null|bool

$db_name  : string

$db_passwd  : string

$db_persist  : bool

$db_port  : int

$db_prefix  : string

$db_server  : string

$db_show_debug  : bool

$db_type  : string

$db_user  : string

$image_proxy_enabled  : bool

$image_proxy_maxsize  : int

$image_proxy_secret  : string

$language  : string

$languagesdir  : string

Path to the Packages directory.

$maintenance  : int

$mbname  : string

$mmessage  : string

Description of why the forum is in maintenance mode.

$modSettings  : array<string|int, mixed>

$mtitle  : string

$packagesdir  : string

Path to the Packages directory.

$scripturl  : string

$sourcedir  : string

$ssi_db_passwd  : string

$ssi_db_user  : string

$webmaster_email  : string

$auth_secret  : string|null

$exported  : bool

$settings_defs  : array<string|int, mixed>

$temp_dir  : string

Methods

checkCron()  : void

Ensures SMF's scheduled tasks are being run as intended

generateSeed()  : void

Generate a random seed and ensure it's stored in settings.

getAuthSecret()  : string

Gets, and if necessary creates, the authentication secret to use for cookies, tokens, etc.

getCurrentSettings()  : array<string|int, mixed>|bool

Retrieves a copy of the current values of all settings in Settings.php.

getDbLastError()  : int

Sets Config::$db_last_error to the timestamp of the last recorded database error for the error log, and also returns that timestamp.

getSettingsDefs()  : array<string|int, mixed>

Describes properties of all known Settings.php variables and other content.

getTempDir()  : string

Locates the most appropriate temporary directory.

load()  : void

Loads properties directly from Settings.php.

reloadModSettings()  : void

Load the Config::$modSettings array.

safeFileWrite()  : bool

Writes data to a file, optionally making a backup, while avoiding race conditions.

set()  : void

Sets the properties of this class to the specified values.

stripPhpComments()  : string

Deletes all PHP comments from a string.

updateDbLastError()  : bool

Saves the time of the last database error for the error log.

updateModSettings()  : void

Updates the settings table as well as Config::$modSettings... - Updates both the settings table and Config::$modSettings array.

updateSettingsFile()  : bool

Update the Settings.php file.

varExport()  : string

A wrapper around var_export() that enhances it for SMF's purposes: