Root Class Reference

Public Member Functions
	__construct ($rootPath)
	errorHandler ($errno, $errstr, $errfile, $errline)
	getAliasPath ($aetrayPath=false)
	getAppsPath ($aetrayPath=false)
	getBatchLogFilePath ($aetrayPath=false)
	getBinPath ($aetrayPath=false)
	getConfigFilePath ($aetrayPath=false)
	getCorePath ($aetrayPath=false)
	getErrorLogFilePath ($aetrayPath=false)
	getExeFilePath ($aetrayPath=false)
	getHomepageFilePath ($aetrayPath=false)
	getHomepageLogFilePath ($aetrayPath=false)
	getIniFilePath ($aetrayPath=false)
	getLocalUrl ($request=null)
	getLogFilePath ($aetrayPath=false)
	getLogsPath ($aetrayPath=false)
	getNssmLogFilePath ($aetrayPath=false)
	getProcessName ()
	getProcs ()
	getRegistryLogFilePath ($aetrayPath=false)
	getRootPath ($aetrayPath=false)
	getServicesLogFilePath ($aetrayPath=false)
	getSslConfPath ($aetrayPath=false)
	getSslPath ($aetrayPath=false)
	getStartupLogFilePath ($aetrayPath=false)
	getTmpPath ($aetrayPath=false)
	getToolsPath ($aetrayPath=false)
	getVhostsPath ($aetrayPath=false)
	getWinbinderLogFilePath ($aetrayPath=false)
	getWwwPath ($aetrayPath=false)
	initErrorHandling ()
	isRoot ()
	register ()
	removeErrorHandling ()

Static Public Member Functions
static	loadApps ()
static	loadBins ()
static	loadConfig ()
static	loadCore ()
static	loadHomepage ()
static	loadLang ()
static	loadOpenSsl ()
static	loadRegistry ()
static	loadTools ()
static	loadWinbinder ()

Data Fields
	$path
const	ERROR_HANDLER = 'errorHandler'

Private Member Functions
	aetrayPath ($path)

Static Private Member Functions
static	debugStringBacktrace ()

Private Attributes
	$isRoot
	$procs

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 29 of file class.root.php.

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

References isRoot().

Member Function Documentation

aetrayPath()

aetrayPath ( $path )

private

Formats a path for AeTrayMenu.

Parameters

string

$path

The path to format.

Returns

string The formatted path.

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

    {
        $path = str_replace($this->getRootPath(), '', $path);
        return '%AeTrayMenuPath%' . substr($path, 1, strlen($path));
    }

References $path, and getRootPath().

Referenced by getCorePath(), and getRootPath().

debugStringBacktrace()

debugStringBacktrace ( )

staticprivate

Generates a debug backtrace string.

Returns

string The debug backtrace.

Definition at line 579 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().

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 536 of file class.root.php.

    {
        if (error_reporting() === 0) {
            return;
        }
 
        $errfile = UtilPath::formatUnixPath($errfile);
        $errfile = str_replace($this->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($this->getErrorLogFilePath(), $content, FILE_APPEND);
    }

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

getAliasPath()

getAliasPath

(

$aetrayPath = false

)

Gets the path to the alias directory.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The alias path.

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

    {
        return $this->getRootPath($aetrayPath) . '/alias';
    }

References getRootPath().

getAppsPath()

getAppsPath

(

$aetrayPath = false

)

Gets the path to the apps directory.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The apps path.

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

    {
        return $this->getRootPath($aetrayPath) . '/apps';
    }

References getRootPath().

getBatchLogFilePath()

getBatchLogFilePath

(

$aetrayPath = false

)

Gets the path to the batch log file.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The batch log file path.

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

    {
        return $this->getLogsPath($aetrayPath) . '/bearsampp-batch.log';
    }

References getLogsPath().

getBinPath()

getBinPath

(

$aetrayPath = false

)

Gets the path to the bin directory.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The bin path.

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

    {
        return $this->getRootPath($aetrayPath) . '/bin';
    }

References getRootPath().

getConfigFilePath()

getConfigFilePath

(

$aetrayPath = false

)

Gets the path to the configuration file.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The configuration file path.

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

    {
        return $this->getRootPath($aetrayPath) . '/bearsampp.conf';
    }

References getRootPath().

getCorePath()

getCorePath

(

$aetrayPath = false

)

Gets the path to the core directory.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The core path.

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

    {
        return $aetrayPath ? $this->aetrayPath($this->path) : $this->path;
    }

References $path, and aetrayPath().

Referenced by register().

getErrorLogFilePath()

getErrorLogFilePath

(

$aetrayPath = false

)

Gets the path to the error log file.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The error log file path.

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

    {
        return $this->getLogsPath($aetrayPath) . '/bearsampp-error.log';
    }

References getLogsPath().

Referenced by errorHandler(), and initErrorHandling().

getExeFilePath()

getExeFilePath

(

$aetrayPath = false

)

Gets the path to the executable file.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The executable file path.

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

    {
        return $this->getRootPath($aetrayPath) . '/bearsampp.exe';
    }

References getRootPath().

getHomepageFilePath()

getHomepageFilePath

(

$aetrayPath = false

)

Gets the path to the homepage file.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The homepage file path.

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

    {
        return $this->getWwwPath($aetrayPath) . '/index.php';
    }

References getWwwPath().

getHomepageLogFilePath()

getHomepageLogFilePath

(

$aetrayPath = false

)

Gets the path to the homepage log file.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The homepage log file path.

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

    {
        return $this->getLogsPath($aetrayPath) . '/bearsampp-homepage.log';
    }

References getLogsPath().

getIniFilePath()

getIniFilePath

(

$aetrayPath = false

)

Gets the path to the INI file.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The INI file path.

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

    {
        return $this->getRootPath($aetrayPath) . '/bearsampp.ini';
    }

References getRootPath().

getLocalUrl()

getLocalUrl

(

$request = null

)

Constructs a local URL with the specified request.

Parameters

string | null

$request

The specific request to append to the URL.

Returns

string The constructed local URL.

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

    {
        global $bearsamppBins;
        return (isset($_SERVER['HTTPS']) ? 'https://' : 'http://') .
            (isset($_SERVER['SERVER_NAME']) ? $_SERVER['SERVER_NAME'] : 'localhost') .
            ($bearsamppBins->getApache()->getPort() != 80 && !isset($_SERVER['HTTPS']) ? ':' . $bearsamppBins->getApache()->getPort() : '') .
            (!empty($request) ? '/' . $request : '');
    }

References $bearsamppBins.

getLogFilePath()

getLogFilePath

(

$aetrayPath = false

)

Gets the path to the log file.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The log file path.

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

    {
        return $this->getLogsPath($aetrayPath) . '/bearsampp.log';
    }

References getLogsPath().

getLogsPath()

getLogsPath

(

$aetrayPath = false

)

Gets the path to the logs directory.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The logs path.

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

    {
        return $this->getRootPath($aetrayPath) . '/logs';
    }

References getRootPath().

Referenced by getBatchLogFilePath(), getErrorLogFilePath(), getHomepageLogFilePath(), getLogFilePath(), getNssmLogFilePath(), getRegistryLogFilePath(), getServicesLogFilePath(), getStartupLogFilePath(), and getWinbinderLogFilePath().

getNssmLogFilePath()

getNssmLogFilePath

(

$aetrayPath = false

)

Gets the path to the NSSM log file.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The NSSM log file path.

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

    {
        return $this->getLogsPath($aetrayPath) . '/bearsampp-nssm.log';
    }

References getLogsPath().

getProcessName()

getProcessName

(

)

Gets the name of the process.

Returns

string The process name.

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

    {
        return 'bearsampp';
    }

getProcs()

getProcs

(

)

Retrieves the list of processes.

Returns

array The list of processes.

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

    {
        return $this->procs;
    }

References $procs.

getRegistryLogFilePath()

getRegistryLogFilePath

(

$aetrayPath = false

)

Gets the path to the registry log file.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The registry log file path.

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

    {
        return $this->getLogsPath($aetrayPath) . '/bearsampp-registry.log';
    }

References getLogsPath().

getRootPath()

getRootPath

(

$aetrayPath = false

)

Gets the root path, optionally formatted for AeTrayMenu.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The root path.

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

    {
        $path = dirname($this->path);
        return $aetrayPath ? $this->aetrayPath($path) : $path;
    }

References $path, and aetrayPath().

Referenced by aetrayPath(), errorHandler(), getAliasPath(), getAppsPath(), getBinPath(), getConfigFilePath(), getExeFilePath(), getIniFilePath(), getLogsPath(), getSslPath(), getTmpPath(), getToolsPath(), getVhostsPath(), and getWwwPath().

getServicesLogFilePath()

getServicesLogFilePath

(

$aetrayPath = false

)

Gets the path to the services log file.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The services log file path.

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

    {
        return $this->getLogsPath($aetrayPath) . '/bearsampp-services.log';
    }

References getLogsPath().

getSslConfPath()

getSslConfPath

(

$aetrayPath = false

)

Gets the path to the SSL configuration file.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The SSL configuration file path.

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

    {
        return $this->getSslPath($aetrayPath) . '/openssl.cnf';
    }

References getSslPath().

getSslPath()

getSslPath

(

$aetrayPath = false

)

Gets the path to the SSL directory.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The SSL path.

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

    {
        return $this->getRootPath($aetrayPath) . '/ssl';
    }

References getRootPath().

Referenced by getSslConfPath().

getStartupLogFilePath()

getStartupLogFilePath

(

$aetrayPath = false

)

Gets the path to the startup log file.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The startup log file path.

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

    {
        return $this->getLogsPath($aetrayPath) . '/bearsampp-startup.log';
    }

References getLogsPath().

getTmpPath()

getTmpPath

(

$aetrayPath = false

)

Gets the path to the temporary directory.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The temporary path.

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

    {
        return $this->getRootPath($aetrayPath) . '/tmp';
    }

References getRootPath().

getToolsPath()

getToolsPath

(

$aetrayPath = false

)

Gets the path to the tools directory.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The tools path.

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

    {
        return $this->getRootPath($aetrayPath) . '/tools';
    }

References getRootPath().

getVhostsPath()

getVhostsPath

(

$aetrayPath = false

)

Gets the path to the virtual hosts directory.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The virtual hosts path.

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

    {
        return $this->getRootPath($aetrayPath) . '/vhosts';
    }

References getRootPath().

getWinbinderLogFilePath()

getWinbinderLogFilePath

(

$aetrayPath = false

)

Gets the path to the Winbinder log file.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The Winbinder log file path.

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

    {
        return $this->getLogsPath($aetrayPath) . '/bearsampp-winbinder.log';
    }

References getLogsPath().

getWwwPath()

getWwwPath

(

$aetrayPath = false

)

Gets the path to the WWW directory.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The WWW path.

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

    {
        return $this->getRootPath($aetrayPath) . '/www';
    }

References getRootPath().

Referenced by getHomepageFilePath().

initErrorHandling()

initErrorHandling

(

)

Initializes error handling settings for the application.

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

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

References getErrorLogFilePath().

Referenced by register().

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 118 of file class.root.php.

    {
        return $this->isRoot;
    }

References $isRoot.

Referenced by __construct(), and register().

loadApps()

loadApps ( )

static

Loads the apps components of the application.

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

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

Referenced by register().

loadBins()

loadBins ( )

static

Loads the binary components of the application.

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

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

References $bearsamppBins.

Referenced by register().

loadConfig()

loadConfig ( )

static

Loads the configuration settings of the application.

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

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

References $bearsamppConfig.

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

loadCore()

loadCore ( )

static

Loads the core components of the application.

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

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

References $bearsamppCore.

Referenced by register().

loadHomepage()

loadHomepage ( )

static

Loads the homepage settings of the application.

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

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

References $bearsamppHomepage.

Referenced by register().

loadLang()

loadLang ( )

static

Loads the language settings of the application.

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

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

References $bearsamppLang.

Referenced by register().

loadOpenSsl()

loadOpenSsl ( )

static

Loads the OpenSSL settings of the application.

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

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

Referenced by register().

loadRegistry()

loadRegistry ( )

static

Loads the registry settings of the application.

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

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

Referenced by register().

loadTools()

loadTools ( )

static

Loads the tools components of the application.

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

    {
        global $bearsamppTools;
        $bearsamppTools = new Tools();
    }

Referenced by register().

loadWinbinder()

loadWinbinder ( )

static

Loads the Winbinder extension if available.

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

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

Referenced by register().

register()

register

(

)

Registers the application components and initializes error handling.

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

    {
        // Params
        set_time_limit(0);
        clearstatcache();
 
        // External classes required for error handling and path utilities
        require_once $this->getCorePath() . '/classes/class.util.path.php';
 
        // Error log
        $this->initErrorHandling();
 
        // External classes
        require_once $this->getCorePath() . '/classes/class.log.php';
        require_once $this->getCorePath() . '/classes/class.util.php';
        require_once $this->getCorePath() . '/classes/class.util.string.php';
        require_once $this->getCorePath() . '/classes/class.httpclient.php';
        Log::init();
 
        // Autoloader
        require_once $this->getCorePath() . '/classes/class.autoloader.php';
        $bearsamppAutoloader = new Autoloader();
        $bearsamppAutoloader->register();
 
        // Load
        self::loadCore();
        self::loadConfig();
        self::loadLang();
        self::loadOpenSsl();
        self::loadBins();
        self::loadTools();
        self::loadApps();
        self::loadWinbinder();
        self::loadRegistry();
        self::loadHomepage();
        Log::separator();
 
        // Init
        if ($this->isRoot) {
            $this->procs = Win32Ps::getListProcs();
        }
    }

References getCorePath(), Win32Ps\getListProcs(), Log\init(), initErrorHandling(), isRoot(), loadApps(), loadBins(), loadConfig(), loadCore(), loadHomepage(), loadLang(), loadOpenSsl(), loadRegistry(), loadTools(), loadWinbinder(), and Log\separator().

removeErrorHandling()

removeErrorHandling

(

)

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

Definition at line 95 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 22 of file class.root.php.

Referenced by isRoot().

$path

$path

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

Referenced by aetrayPath(), getCorePath(), and getRootPath().

$procs

$procs

private

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

Referenced by getProcs().

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