Root Class Reference

Public Member Functions
	__construct ($rootPath)
	errorHandler ($errno, $errstr, $errfile, $errline)
	getProcs ()
	initErrorHandling ()
	isRoot ()
	register ()
	removeErrorHandling ()

Static Public Member Functions
static	clearCaches ()
static	ensureModuleLoaded ($module, $timeout=5000)
static	getCacheStats ()
static	loadApps ()
static	loadAppsAsync ()
static	loadAppsFiber ()
static	loadBins ()
static	loadConfig ()
static	loadCore ()
static	loadHomepage ()
static	loadHomepageAsync ()
static	loadHomepageFiber ()
static	loadLang ()
static	loadOpenSsl ()
static	loadRegistry ()
static	loadRegistryAsync ()
static	loadRegistryFiber ()
static	loadTools ()
static	loadToolsAsync ()
static	loadToolsFiber ()
static	loadWinbinder ()

Data Fields
	$path
const	ERROR_HANDLER = 'errorHandler'

Static Private Member Functions
static	debugStringBacktrace ()

Private Attributes
	$isRoot
	$procs
	$procsLoaded = false

Detailed Description

Class Root

This class represents the root of the Bearsampp application. It handles the initialization, configuration, and management of various components and settings within the application.

Definition at line 16 of file class.root.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$rootPath

)

Constructs a Root object with the specified root path.

Parameters

string

$rootPath

The root path of the application.

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

    {
        $this->path = str_replace('\\', '/', rtrim($rootPath, '/\\'));
        $this->isRoot = $_SERVER['PHP_SELF'] == 'root.php';
        Path::init(dirname($this->path), $this->path);
    }

References Path\init(), and isRoot().

Here is the call graph for this function:

Member Function Documentation

clearCaches()

clearCaches ( )

static

Clear all configuration caches Used on version upgrade or manual reset

Returns

int Number of cache files deleted

Definition at line 170 of file class.root.php.

                                        : int
    {
        return CacheManager::clearAll();
    }

References CacheManager\clearAll().

Here is the call graph for this function:

debugStringBacktrace()

debugStringBacktrace ( )

staticprivate

Generates a debug backtrace string.

Returns

string The debug backtrace.

Definition at line 426 of file class.root.php.

    {
        ob_start();
        debug_print_backtrace();
        $trace = ob_get_contents();
        ob_end_clean();
 
        $trace = preg_replace('/^#0\s+Root::debugStringBacktrace[^\n]*\n/', '', $trace, 1);
        $trace = preg_replace('/^#1\s+isRoot->errorHandler[^\n]*\n/', '', $trace, 1);
        $trace = preg_replace_callback('/^#(\d+)/m', 'debugStringPregReplace', $trace);
        return $trace;
    }

Referenced by errorHandler().

Here is the caller graph for this function:

ensureModuleLoaded()

ensureModuleLoaded ( $module, $timeout = 5000 )

static

Ensures a module is loaded, waiting if it's still loading asynchronously. Safe to call for modules that may be loading in background. Supports both fiber-based and deferred loading mechanisms.

Parameters

string	$module	The module name (use ModuleLoader constants)
int	$timeout	Maximum wait time in milliseconds

Returns

bool True if module loaded successfully

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

    {
        // Try Fiber loader first (if available on PHP 8.1+)
        if (FiberModuleLoader::isAvailable()) {
            return FiberModuleLoader::waitForModule($module, $timeout);
        }
 
        // Fallback to deferred loading
        return ModuleLoader::waitForModule($module, $timeout);
    }

References FiberModuleLoader\isAvailable(), FiberModuleLoader\waitForModule(), and ModuleLoader\waitForModule().

Here is the call graph for this function:

errorHandler()

errorHandler	(		$errno,
			$errstr,
			$errfile,
			$errline )

Handles errors and logs them to the error log file.

Parameters

int	$errno	The level of the error raised.
string	$errstr	The error message.
string	$errfile	The filename that the error was raised in.
int	$errline	The line number the error was raised at.

Definition at line 383 of file class.root.php.

    {
        if (!(error_reporting() & $errno)) {
            return;
        }
 
        $errfile = Path::formatUnixPath($errfile);
        $errfile = str_replace(Path::getRootPath(), '', $errfile);
 
        if (!defined('E_DEPRECATED')) {
            define('E_DEPRECATED', 8192);
        }
 
        $errNames = array(
            E_ERROR             => 'E_ERROR',
            E_WARNING           => 'E_WARNING',
            E_PARSE             => 'E_PARSE',
            E_NOTICE            => 'E_NOTICE',
            E_CORE_ERROR        => 'E_CORE_ERROR',
            E_CORE_WARNING      => 'E_CORE_WARNING',
            E_COMPILE_ERROR     => 'E_COMPILE_ERROR',
            E_COMPILE_WARNING   => 'E_COMPILE_WARNING',
            E_USER_ERROR        => 'E_USER_ERROR',
            E_USER_WARNING      => 'E_USER_WARNING',
            E_USER_NOTICE       => 'E_USER_NOTICE',
            E_RECOVERABLE_ERROR => 'E_RECOVERABLE_ERROR',
            E_DEPRECATED        => 'E_DEPRECATED',
        );
 
        $content = '[' . date('Y-m-d H:i:s', time()) . '] ';
        $content .= $errNames[$errno] . ' ';
        $content .= $errstr . ' in ' .  $errfile;
        $content .= ' on line ' . $errline . PHP_EOL;
        $content .= self::debugStringBacktrace() . PHP_EOL;
 
        file_put_contents(Path::getErrorLogFilePath(), $content, FILE_APPEND);
    }

References debugStringBacktrace(), E_USER_ERROR, Path\formatUnixPath(), Path\getErrorLogFilePath(), and Path\getRootPath().

Here is the call graph for this function:

getCacheStats()

getCacheStats ( )

static

Get cache manager statistics Useful for monitoring warm start performance

Returns

array Cache statistics

Definition at line 159 of file class.root.php.

                                          : array
    {
        return CacheManager::getStats();
    }

References CacheManager\getStats().

Here is the call graph for this function:

getProcs()

getProcs

(

)

Retrieves the list of processes. Lazy loads process list only when accessed.

Returns

array The list of processes.

Definition at line 124 of file class.root.php.

    {
        if (!$this->procsLoaded && $this->isRoot()) {
            $this->procs = Win32Ps::getListProcs();
            $this->procsLoaded = true;
        }
        return $this->procs;
    }

References $procs, Win32Ps\getListProcs(), and isRoot().

Here is the call graph for this function:

initErrorHandling()

initErrorHandling

(

)

Initializes error handling settings for the application.

Definition at line 99 of file class.root.php.

    {
        error_reporting(-1);
        ini_set('error_log', Path::getErrorLogFilePath());
        ini_set('display_errors', '1');
        set_error_handler(array($this, self::ERROR_HANDLER));
    }

References Path\getErrorLogFilePath().

Referenced by register().

Here is the call graph for this function:

Here is the caller graph for this function:

isRoot()

isRoot

(

)

Checks if the current script is executed from the root path.

Returns

bool True if executed from the root, false otherwise.

Definition at line 180 of file class.root.php.

    {
        return $this->isRoot;
    }

References $isRoot.

Referenced by __construct(), and getProcs().

Here is the caller graph for this function:

loadApps()

loadApps ( )

static

Loads the apps components of the application.

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

    {
        global $bearsamppApps;
        $bearsamppApps = new Apps();
    }

loadAppsAsync()

loadAppsAsync ( )

static

Loads the apps components asynchronously. Apps module loads in background without blocking main thread.

Definition at line 295 of file class.root.php.

    {
        ModuleLoader::loadAsync(ModuleLoader::APPS, function() {
            global $bearsamppApps;
            $bearsamppApps = new Apps();
        });
    }

References ModuleLoader\APPS, and ModuleLoader\loadAsync().

Referenced by register().

Here is the call graph for this function:

Here is the caller graph for this function:

loadAppsFiber()

loadAppsFiber ( )

static

Loads the apps components in a Fiber (true async, PHP 8.1+) Apps module loads concurrently with main startup.

Definition at line 343 of file class.root.php.

    {
        FiberModuleLoader::loadInFiber(ModuleLoader::APPS, function() {
            global $bearsamppApps;
            $bearsamppApps = new Apps();
        });
    }

References ModuleLoader\APPS, and FiberModuleLoader\loadInFiber().

Referenced by register().

Here is the call graph for this function:

Here is the caller graph for this function:

loadBins()

loadBins ( )

static

Loads the binary components of the application.

Definition at line 224 of file class.root.php.

    {
        global $bearsamppBins;
        $bearsamppBins = new Bins();
    }

References $bearsamppBins.

Referenced by register().

Here is the caller graph for this function:

loadConfig()

loadConfig ( )

static

Loads the configuration settings of the application.

Definition at line 197 of file class.root.php.

    {
        global $bearsamppConfig;
        $bearsamppConfig = new Config();
    }

References $bearsamppConfig.

Referenced by ActionSwitchVersion\processWindow(), and register().

Here is the caller graph for this function:

loadCore()

loadCore ( )

static

Loads the core components of the application.

Definition at line 188 of file class.root.php.

    {
        global $bearsamppCore;
        $bearsamppCore = new Core();
    }

References $bearsamppCore.

Referenced by register().

Here is the caller graph for this function:

loadHomepage()

loadHomepage ( )

static

Loads the homepage settings of the application.

Definition at line 273 of file class.root.php.

    {
        global $bearsamppHomepage;
        $bearsamppHomepage = new Homepage();
    }

References $bearsamppHomepage.

loadHomepageAsync()

loadHomepageAsync ( )

static

Loads the homepage settings asynchronously. Homepage is for UI display, can load in background.

Definition at line 319 of file class.root.php.

    {
        ModuleLoader::loadAsync(ModuleLoader::HOMEPAGE, function() {
            global $bearsamppHomepage;
            $bearsamppHomepage = new Homepage();
        });
    }

References $bearsamppHomepage, ModuleLoader\HOMEPAGE, and ModuleLoader\loadAsync().

Referenced by register().

Here is the call graph for this function:

Here is the caller graph for this function:

loadHomepageFiber()

loadHomepageFiber ( )

static

Loads the homepage settings in a Fiber (true async, PHP 8.1+) Homepage is for UI display, loads concurrently.

Definition at line 367 of file class.root.php.

    {
        FiberModuleLoader::loadInFiber(ModuleLoader::HOMEPAGE, function() {
            global $bearsamppHomepage;
            $bearsamppHomepage = new Homepage();
        });
    }

References $bearsamppHomepage, ModuleLoader\HOMEPAGE, and FiberModuleLoader\loadInFiber().

Referenced by register().

Here is the call graph for this function:

Here is the caller graph for this function:

loadLang()

loadLang ( )

static

Loads the language settings of the application.

Definition at line 206 of file class.root.php.

    {
        global $bearsamppLang;
        $bearsamppLang = new LangProc();
    }

References $bearsamppLang.

Referenced by register().

Here is the caller graph for this function:

loadOpenSsl()

loadOpenSsl ( )

static

Loads the OpenSSL settings of the application.

Definition at line 215 of file class.root.php.

    {
        global $bearsamppOpenSsl;
        $bearsamppOpenSsl = new OpenSsl();
    }

Referenced by register().

Here is the caller graph for this function:

loadRegistry()

loadRegistry ( )

static

Loads the registry settings of the application.

Definition at line 264 of file class.root.php.

    {
        global $bearsamppRegistry;
        $bearsamppRegistry = new Registry();
    }

loadRegistryAsync()

loadRegistryAsync ( )

static

Loads the registry settings asynchronously. Registry operations are slow (COM), loads in background.

Definition at line 307 of file class.root.php.

    {
        ModuleLoader::loadAsync(ModuleLoader::REGISTRY, function() {
            global $bearsamppRegistry;
            $bearsamppRegistry = new Registry();
        });
    }

References ModuleLoader\loadAsync(), and ModuleLoader\REGISTRY.

Referenced by register().

Here is the call graph for this function:

Here is the caller graph for this function:

loadRegistryFiber()

loadRegistryFiber ( )

static

Loads the registry settings in a Fiber (true async, PHP 8.1+) Registry operations are slow (COM), loads concurrently.

Definition at line 355 of file class.root.php.

    {
        FiberModuleLoader::loadInFiber(ModuleLoader::REGISTRY, function() {
            global $bearsamppRegistry;
            $bearsamppRegistry = new Registry();
        });
    }

References FiberModuleLoader\loadInFiber(), and ModuleLoader\REGISTRY.

Referenced by register().

Here is the call graph for this function:

Here is the caller graph for this function:

loadTools()

loadTools ( )

static

Loads the tools components of the application.

Definition at line 233 of file class.root.php.

    {
        global $bearsamppTools;
        if (!isset($bearsamppTools)) {
            $bearsamppTools = new Tools();
        }
    }

Referenced by Win32Service\create().

Here is the caller graph for this function:

loadToolsAsync()

loadToolsAsync ( )

static

Loads the tools components asynchronously. Tools module loads in background without blocking main thread.

Definition at line 283 of file class.root.php.

    {
        ModuleLoader::loadAsync(ModuleLoader::TOOLS, function() {
            global $bearsamppTools;
            $bearsamppTools = new Tools();
        });
    }

References ModuleLoader\loadAsync(), and ModuleLoader\TOOLS.

Referenced by register().

Here is the call graph for this function:

Here is the caller graph for this function:

loadToolsFiber()

loadToolsFiber ( )

static

Loads the tools components in a Fiber (true async, PHP 8.1+) Tools module loads concurrently with main startup.

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

    {
        FiberModuleLoader::loadInFiber(ModuleLoader::TOOLS, function() {
            global $bearsamppTools;
            $bearsamppTools = new Tools();
        });
    }

References FiberModuleLoader\loadInFiber(), and ModuleLoader\TOOLS.

Referenced by register().

Here is the call graph for this function:

Here is the caller graph for this function:

loadWinbinder()

loadWinbinder ( )

static

Loads the Winbinder extension if available.

Definition at line 253 of file class.root.php.

    {
        global $bearsamppWinbinder;
        if (extension_loaded('winbinder')) {
            $bearsamppWinbinder = new WinBinder();
        }
    }

Referenced by register().

Here is the caller graph for this function:

register()

register

(

)

Registers the application components and initializes error handling.

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

    {
        // Params
        set_time_limit(0);
        clearstatcache();
 
        // Error log
        $this->initErrorHandling();
 
        // External classes
        require_once $this->path . '/classes/class.log.php';
        require_once $this->path . '/classes/class.util.php';
        require_once $this->path . '/classes/class.util.string.php';
        Log::init();
 
        // Autoloader
        require_once $this->path . '/classes/class.autoloader.php';
        $bearsamppAutoloader = new Autoloader();
        $bearsamppAutoloader->register();
 
        // Module loaders for async initialization
        require_once $this->path . '/classes/class.moduleloader.php';
        require_once $this->path . '/classes/class.cachemanager.php';
        require_once $this->path . '/classes/class.fibermoduleloader.php';
 
        // Initialize cache system (disk caching for warm starts)
        CacheManager::init(Path::getTmpPath() . '/cache');
 
        // Initialize fiber loader (true async for 8.1+)
        $useFibers = FiberModuleLoader::init();
 
        // Load critical modules synchronously (required for main functionality)
        self::loadCore();
        self::loadConfig();
        self::loadLang();
        self::loadOpenSsl();
        self::loadBins();
        Log::separator();
 
        // Load non-critical modules asynchronously (for UI/admin functions)
        // Uses Fibers if PHP 8.1+, fallback to deferred loading
        if ($useFibers) {
            self::loadToolsFiber();
            self::loadAppsFiber();
            self::loadRegistryFiber();
            self::loadHomepageFiber();
        } else {
            self::loadToolsAsync();
            self::loadAppsAsync();
            self::loadRegistryAsync();
            self::loadHomepageAsync();
        }
 
        self::loadWinbinder();
    }

References Path\getTmpPath(), CacheManager\init(), FiberModuleLoader\init(), Log\init(), initErrorHandling(), loadAppsAsync(), loadAppsFiber(), loadBins(), loadConfig(), loadCore(), loadHomepageAsync(), loadHomepageFiber(), loadLang(), loadOpenSsl(), loadRegistryAsync(), loadRegistryFiber(), loadToolsAsync(), loadToolsFiber(), loadWinbinder(), and Log\separator().

Here is the call graph for this function:

removeErrorHandling()

removeErrorHandling

(

)

Removes the custom error handling, reverting to the default PHP error handling.

Definition at line 110 of file class.root.php.

    {
        error_reporting(0);
        ini_set('error_log', null);
        ini_set('display_errors', '0');
        restore_error_handler();
    }

Field Documentation

$isRoot

$isRoot

private

Definition at line 23 of file class.root.php.

Referenced by isRoot().

$path

$path

Definition at line 20 of file class.root.php.

$procs

$procs

private

Definition at line 21 of file class.root.php.

Referenced by getProcs().

$procsLoaded

$procsLoaded = false

private

Definition at line 22 of file class.root.php.

ERROR_HANDLER

const ERROR_HANDLER = 'errorHandler'

Definition at line 18 of file class.root.php.

---

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

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