Static Public Member Functions
static	debug ($data, $file=null)
static	error ($data, $file=null)
static	flush ()
static	getBufferSize ()
static	getStats ()
static	info ($data, $file=null)
static	init ()
static	initClass ($classInstance)
static	reloadClass ($classInstance)
static	reset ()
static	separator ()
static	setBufferSize ($size)
static	trace ($data, $file=null)
static	warning ($data, $file=null)

Data Fields
const	DEBUG = 'DEBUG'
const	ERROR = 'ERROR'
const	INFO = 'INFO'
const	TRACE = 'TRACE'
const	WARNING = 'WARNING'

Static Private Member Functions
static	write ($data, $type, $file=null)

Static Private Attributes
static	$logBuffer = []
static	$logBufferSize = 50
static	$logStats
static	$shutdownRegistered = false

Detailed Description

Log class providing static logging methods with buffered I/O.

Supports five log levels (TRACE, DEBUG, INFO, WARNING, ERROR), a separator utility, class-lifecycle helpers, and a configurable write buffer to reduce file-system pressure.

Call Log\init() once during bootstrap (after globals are available) to register the shutdown flush handler.

Usage:

Log::init();
Log::info('Application started');
Log::error('Something went wrong');

Definition at line 28 of file class.log.php.

Member Function Documentation

◆ debug()

debug	(		$data,
			$file = null )

static

Logs a DEBUG-level message.

Parameters

mixed	$data
string \| null	$file

Definition at line 287 of file class.log.php.

    {
        self::write($data, self::DEBUG, $file);
    }

References write().

Referenced by ActionQuit\__construct(), Action\call(), Util\changePath(), BinApache\changePort(), BinMailpit\changePort(), BinMariadb\changePort(), BinMemcached\changePort(), BinMysql\changePort(), BinPostgresql\changePort(), BinXlight\changePort(), QuickPick\checkDownloadId(), ActionQuit\checkForOrphanedProcesses(), BinApache\checkPort(), BinMailpit\checkPort(), BinMariadb\checkPort(), BinMemcached\checkPort(), BinMysql\checkPort(), BinPostgresql\checkPort(), BinXlight\checkPort(), Csrf\cleanupExpiredTokens(), ActionQuit\cleanupTemporaryFiles(), Win32Native\countFilesFolders(), Win32Native\countFilesFoldersCOM(), Win32Native\createShortcut(), QuickPick\fetchAndUnzipModule(), Csrf\generateToken(), Util\getAppBinsRegKey(), Win32Native\getDefaultBrowser(), Util\getFilesToScan(), Util\getHeaders(), HttpClient\getHttpHeaders(), Win32Native\getInstalledBrowsers(), Util\getLatestVersion(), QuickPick\getModuleUrl(), Win32Native\getProcessList(), Win32Native\getServiceInfo(), Win32Native\getSpecialFolderPath(), QuickPick\getVersions(), BinPostgresql\handleNonPostgresUsage(), Win32Service\infos(), QuickPick\installModule(), Win32Native\killProcess(), Win32Native\listServices(), QuickPick\logHeaders(), ActionQuit\performQuickCleanupVerification(), Action\process(), ActionQuit\processWindow(), QuickPick\rebuildQuickpickJson(), BinApache\refreshAlias(), BinApache\refreshConf(), BinApache\refreshVhosts(), QuickPick\regenerateMenuSafe(), Win32Native\registryDeleteKey(), Win32Native\registryDeleteValue(), Win32Native\registryExists(), Win32Native\registryGetValue(), Win32Native\registrySetValue(), Symlinks\safeRemoveSymlink(), ActionStartup\scanFolders(), BinApache\setEnable(), BinMailpit\setEnable(), BinMariadb\setEnable(), BinMemcached\setEnable(), BinMysql\setEnable(), BinNodejs\setEnable(), BinPhp\setEnable(), BinPostgresql\setEnable(), BinXlight\setEnable(), Util\setFileScanCache(), Util\setFileScanCacheDuration(), Win32Service\start(), BinApache\switchVersion(), BinMailpit\switchVersion(), BinMariadb\switchVersion(), BinMemcached\switchVersion(), BinMysql\switchVersion(), BinNodejs\switchVersion(), BinPhp\switchVersion(), BinPostgresql\switchVersion(), BinXlight\switchVersion(), Core\unzipFile(), AppPhpmyadmin\updateConfig(), AppPhppgadmin\updateConfig(), BinApache\updateConfig(), BinMailpit\updateConfig(), BinMariadb\updateConfig(), BinMemcached\updateConfig(), BinMysql\updateConfig(), BinNodejs\updateConfig(), BinPhp\updateConfig(), BinPostgresql\updateConfig(), BinXlight\updateConfig(), Module\updateConfig(), ToolGit\updateConfig(), QuickPick\updateModuleConfig(), Csrf\validateToken(), ActionQuit\verifyServicesStoppedAndCleanup(), ActionStartup\writeLog(), Batch\writeLog(), CommandRunner\writeLog(), Nssm\writeLog(), Registry\writeLog(), Win32Service\writeLog(), and WinBinder\writeLog().

◆ error()

error	(		$data,
			$file = null )

static

Logs an ERROR-level message. Errors bypass the buffer and are written immediately.

Parameters

mixed	$data
string \| null	$file

Definition at line 321 of file class.log.php.

    {
        self::write($data, self::ERROR, $file);
    }

References write().

Referenced by ActionLoading\__construct(), BinApache\changePort(), BinMailpit\changePort(), BinMariadb\changePort(), BinMemcached\changePort(), BinMysql\changePort(), BinPostgresql\changePort(), BinXlight\changePort(), QuickPick\checkDownloadId(), ActionQuit\checkForOrphanedProcesses(), BinApache\checkPort(), BinMailpit\checkPort(), BinMariadb\checkPort(), BinMemcached\checkPort(), BinMysql\checkPort(), BinPostgresql\checkPort(), BinXlight\checkPort(), ActionQuit\cleanupTemporaryFiles(), Win32Native\countFilesFolders(), Win32Native\countFilesFoldersCOM(), Win32Native\createShortcut(), Module\createSymlink(), Symlinks\deleteCurrentSymlinks(), QuickPick\fetchAndUnzipModule(), Win32Native\findProcessesByName(), UtilString\generateSecureBytes(), UtilString\generateSecureToken(), Csrf\generateToken(), HttpClient\get(), Core\getAppVersion(), Util\getCacheIntegrityKey(), HttpClient\getCurlHeaders(), HttpClient\getCurlHttpHeaders(), Core\getFileFromUrl(), Util\getLatestVersion(), QuickPick\getModuleUrl(), Win32Native\getProcessInfo(), Win32Native\getProcessList(), QuickPick\getQuickpickJson(), Win32Native\getServiceInfo(), Win32Native\getSpecialFolderPath(), QuickPick\getVersions(), Splash\init(), BinMariadb\initData(), QuickPick\installModule(), Util\installService(), Symlinks\isPathWithinAllowedBase(), Win32Native\killProcess(), Win32Native\listServices(), ActionCheckVersion\processWindow(), UtilString\random(), Win32Native\registryDeleteKey(), Win32Native\registryDeleteValue(), Win32Native\registryExists(), Win32Native\registrySetValue(), AppPhpmyadmin\reload(), AppPhppgadmin\reload(), BinApache\reload(), BinMailpit\reload(), BinMariadb\reload(), BinMemcached\reload(), BinMysql\reload(), BinNodejs\reload(), BinPhp\reload(), BinPostgresql\reload(), BinXlight\reload(), ToolBruno\reload(), ToolComposer\reload(), ToolGhostscript\reload(), ToolGit\reload(), ToolNgrok\reload(), ToolPerl\reload(), ToolPowerShell\reload(), ToolPython\reload(), ToolRuby\reload(), Util\removeService(), Symlinks\safeRemoveSymlink(), Win32Service\start(), Util\startService(), TplAppReload\triggerReload(), Core\unzipFile(), AppPhpmyadmin\updateConfig(), AppPhppgadmin\updateConfig(), BinApache\updateConfig(), BinMailpit\updateConfig(), BinMariadb\updateConfig(), BinMemcached\updateConfig(), BinMysql\updateConfig(), BinNodejs\updateConfig(), BinPhp\updateConfig(), BinPostgresql\updateConfig(), BinXlight\updateConfig(), QuickPick\updateModuleConfig(), ActionQuit\verifyServicesStoppedAndCleanup(), ActionQuit\verifySymlinksRemoved(), and Nssm\writeLogError().

◆ flush()

flush ( )

static

Flushes the log buffer to disk. Groups entries by file to minimise file operations. Falls back to error_log() if globals are unavailable or a write fails.

Returns: void

Definition at line 142 of file class.log.php.

    {
        if (empty(self::$logBuffer)) {
            return;
        }
 
        global $bearsamppCore;
 
        // If the core global is gone (e.g. during an abnormal shutdown), fall back to error_log
        if (!isset($bearsamppCore)) {
            foreach (self::$logBuffer as $log) {
                error_log('[' . date('Y-m-d H:i:s', $log['time']) . '] [' . $log['type'] . '] ' . $log['data']);
            }
            self::$logStats['flushed'] += count(self::$logBuffer);
            self::$logBuffer = [];
            return;
        }
 
        // Group logs by destination file
        $logsByFile = [];
        foreach (self::$logBuffer as $log) {
            $logsByFile[$log['file']][] = $log;
        }
 
        foreach ($logsByFile as $file => $logs) {
            $content = '';
            foreach ($logs as $log) {
                $content .= '[' . date('Y-m-d H:i:s', $log['time']) . '] # ' .
                            APP_TITLE . ' ' . $bearsamppCore->getAppVersion() . ' # ' .
                            $log['type'] . ': ' . $log['data'] . PHP_EOL;
            }
 
            $written = @file_put_contents($file, $content, FILE_APPEND | LOCK_EX);
            if ($written === false) {
                // File write failed — ensure entries are not silently lost
                foreach ($logs as $log) {
                    error_log('[' . $log['type'] . '] ' . $log['data'] . ' (target: ' . $file . ')');
                }
            }
 
            self::$logStats['writes']++;
        }
 
        self::$logStats['flushed'] += count(self::$logBuffer);
        self::$logBuffer = [];
    }

References $bearsamppCore, and APP_TITLE.

Referenced by write().

◆ getBufferSize()

getBufferSize ( )

static

Returns the current log buffer size.

Returns: int

Definition at line 234 of file class.log.php.

    {
        return self::$logBufferSize;
    }

◆ getStats()

getStats ( )

static

Returns the current log buffer statistics.

Returns: array Array with keys 'buffered', 'flushed', and 'writes'.

Definition at line 211 of file class.log.php.

    {
        return self::$logStats;
    }

◆ info()

info	(		$data,
			$file = null )

static

Logs an INFO-level message.

Parameters

mixed	$data
string \| null	$file

Definition at line 298 of file class.log.php.

    {
        self::write($data, self::INFO, $file);
    }

References write().

Referenced by ActionQuit\__construct(), ActionStartup\__construct(), ActionQuit\checkForOrphanedProcesses(), ActionQuit\cleanupTemporaryFiles(), Util\clearFileScanCache(), Batch\exitApp(), Util\getFilesToScan(), Util\installService(), ActionQuit\performQuickCleanupVerification(), ActionQuit\processWindow(), AppPhpmyadmin\reload(), AppPhppgadmin\reload(), Apps\reload(), BinApache\reload(), BinMailpit\reload(), BinMariadb\reload(), BinMemcached\reload(), BinMysql\reload(), BinNodejs\reload(), BinPhp\reload(), BinPostgresql\reload(), Bins\reload(), BinXlight\reload(), ToolBruno\reload(), ToolComposer\reload(), ToolGhostscript\reload(), ToolGit\reload(), ToolNgrok\reload(), ToolPerl\reload(), ToolPowerShell\reload(), ToolPython\reload(), ToolRuby\reload(), Util\removeService(), BinApache\setEnable(), BinMailpit\setEnable(), BinMariadb\setEnable(), BinMemcached\setEnable(), BinMysql\setEnable(), BinNodejs\setEnable(), BinPhp\setEnable(), BinPostgresql\setEnable(), BinXlight\setEnable(), Win32Service\start(), Apps\update(), Bins\update(), Tools\update(), QuickPick\updateModuleConfig(), ActionQuit\verifyServicesStoppedAndCleanup(), ActionQuit\verifySymlinksRemoved(), and Nssm\writeLogInfo().

◆ init()

init ( )

static

Registers the shutdown flush handler. Call once during bootstrap after globals are initialised.

Returns: void

Definition at line 58 of file class.log.php.

    {
        if (!self::$shutdownRegistered) {
            register_shutdown_function([__CLASS__, 'flush']);
            self::$shutdownRegistered = true;
        }
    }

Referenced by Root\register(), and write().

◆ initClass()

initClass ( $classInstance )

static

Logs the initialisation of a class instance at TRACE level.

Parameters

object $classInstance

Definition at line 331 of file class.log.php.

    {
        self::trace('Init ' . get_class($classInstance));
    }

References trace().

Referenced by AppPhpmyadmin\__construct(), AppPhppgadmin\__construct(), BinApache\__construct(), BinMailpit\__construct(), BinMariadb\__construct(), BinMemcached\__construct(), BinMysql\__construct(), BinNodejs\__construct(), BinPhp\__construct(), BinPostgresql\__construct(), Bins\__construct(), BinXlight\__construct(), Homepage\__construct(), Nssm\__construct(), Registry\__construct(), Splash\__construct(), ToolBruno\__construct(), ToolComposer\__construct(), ToolGhostscript\__construct(), ToolGit\__construct(), ToolNgrok\__construct(), ToolPerl\__construct(), ToolPowerShell\__construct(), ToolPython\__construct(), ToolRuby\__construct(), Win32Service\__construct(), and WinBinder\__construct().

◆ reloadClass()

reloadClass ( $classInstance )

static

Logs the reloading of a class instance at TRACE level.

Parameters

object $classInstance

Definition at line 341 of file class.log.php.

    {
        self::trace('Reload ' . get_class($classInstance));
    }

References trace().

Referenced by AppPhpmyadmin\reload(), AppPhppgadmin\reload(), BinApache\reload(), BinMailpit\reload(), BinMariadb\reload(), BinMemcached\reload(), BinMysql\reload(), BinNodejs\reload(), BinPhp\reload(), BinPostgresql\reload(), BinXlight\reload(), ToolBruno\reload(), ToolComposer\reload(), ToolGhostscript\reload(), ToolGit\reload(), ToolNgrok\reload(), ToolPerl\reload(), ToolPowerShell\reload(), ToolPython\reload(), and ToolRuby\reload().

◆ reset()

reset ( )

static

Clears the buffer and resets statistics. Useful in tests or when re-initialising the application.

Returns: void

Definition at line 195 of file class.log.php.

    {
        self::$logBuffer         = [];
        self::$shutdownRegistered = false;
        self::$logStats          = [
            'buffered' => 0,
            'flushed'  => 0,
            'writes'   => 0,
        ];
    }

◆ separator()

separator ( )

static

Appends a separator line to each log file that does not already end with one.

@global object $bearsamppRoot

Definition at line 244 of file class.log.php.

    {
        global $bearsamppRoot;
 
        $logs = [
            $bearsamppRoot->getLogFilePath(),
            $bearsamppRoot->getErrorLogFilePath(),
            $bearsamppRoot->getServicesLogFilePath(),
            $bearsamppRoot->getRegistryLogFilePath(),
            $bearsamppRoot->getStartupLogFilePath(),
            $bearsamppRoot->getBatchLogFilePath(),
            $bearsamppRoot->getWinbinderLogFilePath(),
        ];
 
        $separator = '========================================================================================' . PHP_EOL;
        foreach ($logs as $log) {
            if (!file_exists($log)) {
                continue;
            }
            $logContent = @file_get_contents($log);
            if ($logContent !== false && !str_ends_with($logContent, $separator)) {
                file_put_contents($log, $separator, FILE_APPEND);
            }
        }
    }

References $bearsamppRoot.

Referenced by Root\register().

◆ setBufferSize()

setBufferSize ( $size )

static

Sets the log buffer size.

Parameters

int $size New buffer size (1–1000).

Returns: void

Definition at line 222 of file class.log.php.

    {
        if ($size > 0 && $size <= 1000) {
            self::$logBufferSize = $size;
        }
    }

◆ trace()

trace	(		$data,
			$file = null )

static

Logs a TRACE-level message.

Parameters

mixed	$data
string \| null	$file

Definition at line 276 of file class.log.php.

    {
        self::write($data, self::TRACE, $file);
    }

References write().

Referenced by ActionExec\__construct(), ActionLoading\__construct(), ActionManualRestart\__construct(), ActionRebuildini\__construct(), Win32Service\callWin32Service(), BinMysql\changeRootPassword(), ActionLoading\checkAllServicesStarted(), ActionStartup\checkApacheServiceWithTimeout(), ActionStartup\checkMySQLServiceWithTimeout(), BinMysql\checkPort(), BinMysql\checkRootPassword(), Win32Service\create(), OpenSsl\createCrt(), Win32Service\delete(), Win32Service\ensureReset(), Win32Service\fastServiceCheck(), Win32Service\infos(), initClass(), BinMariadb\initData(), BinMysql\initData(), ActionStartup\installServices(), ActionStartup\installServicesSequential(), Win32Service\isInstalled(), Win32Service\isPaused(), Win32Service\isPending(), Win32Service\isRunning(), Win32Service\isStopped(), ActionStartup\prepareService(), ActionLoading\processLoading(), ActionStartup\processWindow(), ActionSwitchVersion\processWindow(), BinMailpit\rebuildConf(), BinApache\refreshAlias(), BinApache\refreshConf(), BinApache\refreshVhosts(), reloadClass(), Config\replaceAll(), Util\replaceInFile(), ActionStartup\rotationLogs(), ActionStartup\scanFolders(), BinMailpit\setVersion(), BinPhp\setVersion(), Util\startLoading(), Win32Service\status(), Win32Service\stop(), ActionQuit\terminatePhpProcesses(), TplAppReload\triggerReload(), Core\unzipFile(), BinPhp\updateConfig(), ActionSwitchVersion\updateConfigVersion(), and Win32Service\waitForServiceDeletion().

◆ warning()

warning	(		$data,
			$file = null )

static

Logs a WARNING-level message.

Parameters

mixed	$data
string \| null	$file

Definition at line 309 of file class.log.php.

    {
        self::write($data, self::WARNING, $file);
    }

References write().

Referenced by ActionQuit\checkForOrphanedProcesses(), ActionQuit\cleanupTemporaryFiles(), Util\getFileScanCache(), Batch\initializeMariadb(), Batch\initializeMysql(), Batch\initializePostgresql(), Util\installService(), ActionQuit\performQuickCleanupVerification(), ActionQuit\processWindow(), QuickPick\regenerateMenuSafe(), ToolGit\reload(), Util\removeService(), Symlinks\safeRemoveSymlink(), UtilInput\sanitizePath(), UtilInput\sanitizePID(), UtilInput\sanitizePort(), UtilInput\sanitizeServiceName(), Csrf\validateRequest(), Csrf\validateToken(), ActionQuit\verifyServicesStoppedAndCleanup(), and ActionQuit\verifySymlinksRemoved().

◆ write()

write	(	$data,
		$type,
		$file = null )

staticprivate

Writes a message to a log file, using the buffer to reduce I/O.

The file path is resolved as follows:

If $file is provided by the caller it is used as-is.
Otherwise the default path is chosen based on $type (error log vs. main log), then overridden with the homepage log when not running in root context.

Parameters

mixed	$data	The message to log.
string	$type	One of the Log level constants.
string \| null	$file	Explicit file path, or null to use the default.

Definition at line 78 of file class.log.php.

    {
        global $bearsamppRoot, $bearsamppCore, $bearsamppConfig;
 
        // Safety check: if globals aren't initialised, fall back to error_log
        if (!isset($bearsamppRoot) || !isset($bearsamppCore) || !isset($bearsamppConfig)) {
            error_log('[' . $type . '] ' . $data);
            return;
        }
 
        // Lazily register the shutdown handler if init() was not called explicitly
        self::init();
 
        // Resolve default file path only when the caller did not supply one
        if ($file === null) {
            $file = $type === self::ERROR
                ? $bearsamppRoot->getErrorLogFilePath()
                : $bearsamppRoot->getLogFilePath();
 
            if (!$bearsamppRoot->isRoot()) {
                $file = $bearsamppRoot->getHomepageLogFilePath();
            }
        }
 
        $verbose                         = [];
        $verbose[Config::VERBOSE_SIMPLE] = $type === self::ERROR || $type === self::WARNING;
        $verbose[Config::VERBOSE_REPORT] = $verbose[Config::VERBOSE_SIMPLE] || $type === self::INFO;
        $verbose[Config::VERBOSE_DEBUG]  = $verbose[Config::VERBOSE_REPORT] || $type === self::DEBUG;
        $verbose[Config::VERBOSE_TRACE]  = $verbose[Config::VERBOSE_DEBUG] || $type === self::TRACE;
 
        $writeLog = false;
        if ($bearsamppConfig->getLogsVerbose() === Config::VERBOSE_SIMPLE && $verbose[Config::VERBOSE_SIMPLE]) {
            $writeLog = true;
        } elseif ($bearsamppConfig->getLogsVerbose() === Config::VERBOSE_REPORT && $verbose[Config::VERBOSE_REPORT]) {
            $writeLog = true;
        } elseif ($bearsamppConfig->getLogsVerbose() === Config::VERBOSE_DEBUG && $verbose[Config::VERBOSE_DEBUG]) {
            $writeLog = true;
        } elseif ($bearsamppConfig->getLogsVerbose() === Config::VERBOSE_TRACE && $verbose[Config::VERBOSE_TRACE]) {
            $writeLog = true;
        }
 
        if ($writeLog) {
            self::$logBuffer[] = [
                'file' => $file,
                'data' => $data,
                'type' => $type,
                'time' => time(),
            ];
            self::$logStats['buffered']++;
 
            // Flush immediately for errors, or when the buffer is full
            if ($type === self::ERROR || count(self::$logBuffer) >= self::$logBufferSize) {
                self::flush();
            }
        }
    }

References $bearsamppConfig, $bearsamppCore, $bearsamppRoot, flush(), init(), Config\VERBOSE_DEBUG, Config\VERBOSE_REPORT, Config\VERBOSE_SIMPLE, and Config\VERBOSE_TRACE.

Referenced by debug(), error(), info(), trace(), and warning().

Field Documentation

◆ $logBuffer

$logBuffer = []

staticprivate

Definition at line 37 of file class.log.php.

◆ $logBufferSize

$logBufferSize = 50

staticprivate

Definition at line 40 of file class.log.php.

◆ $logStats

$logStats

staticprivate

Initial value:

                         = [
    'buffered' => 0,
    'flushed'  => 0,
    'writes'   => 0,
]

Definition at line 46 of file class.log.php.

◆ $shutdownRegistered

$shutdownRegistered = false

staticprivate

Definition at line 43 of file class.log.php.

◆ DEBUG

const DEBUG = 'DEBUG'

Definition at line 33 of file class.log.php.

◆ ERROR

const ERROR = 'ERROR'

Definition at line 30 of file class.log.php.

◆ INFO

const INFO = 'INFO'

Definition at line 32 of file class.log.php.

◆ TRACE

const TRACE = 'TRACE'

Definition at line 34 of file class.log.php.

◆ WARNING

const WARNING = 'WARNING'

Definition at line 31 of file class.log.php.

The documentation for this class was generated from the following file:

E:/Bearsampp-development/sandbox/core/classes/class.log.php

Static Public Member Functions

Data Fields

Static Private Member Functions

Static Private Attributes

Detailed Description

Member Function Documentation

◆ debug()

◆ error()

◆ flush()

◆ getBufferSize()

◆ getStats()

◆ info()

◆ init()

◆ initClass()

◆ reloadClass()

◆ reset()

◆ separator()

◆ setBufferSize()

◆ trace()

◆ warning()

◆ write()

Field Documentation

◆ $logBuffer

◆ $logBufferSize

◆ $logStats

◆ $shutdownRegistered

◆ DEBUG

◆ ERROR

◆ INFO

◆ TRACE

◆ WARNING