Inheritance diagram for Module:

Public Member Functions
	__toString ()
	getId ()
	getName ()
	getRelease ()
	getType ()
	getVersion ()
	getVersionList ()
	isEnable ()
	setVersion ($version)
	update ($sub=0, $showWindow=false)

Static Public Member Functions
static	clearMemoryCache ()
static	invalidateConfigCacheForPath ($sourcePath)

Data Fields
	$currentPath
	$rootPath
	$symlinkPath

Protected Member Functions
	__construct ()
	reload ($id=null, $type=null)
	replace ($key, $value)
	replaceAll ($params)
	updateConfig ($version=null, $sub=0, $showWindow=false)

Protected Attributes
	$bearsamppConf
	$bearsamppConfRaw
	$enable
	$name
	$release = 'N/A'
	$version

Private Attributes
	$id
	$type

Static Private Attributes
static	$configCache = array()

Detailed Description

Abstract class representing a module in the Bearsampp application. This class provides common functionalities for managing modules such as apps, bins, and tools.

Definition at line 14 of file class.module.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

protected

Constructor for the Module class. Initializes the module with default values.

Definition at line 56 of file class.module.php.

    {
        // Initialization logic can be added here if needed
    }

Member Function Documentation

◆ __toString()

__toString ( )

Returns the name of the module.

Returns: string The name of the module.

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

    {
        return $this->getName();
    }

References getName().

Here is the call graph for this function:

◆ clearMemoryCache()

clearMemoryCache ( )

static

Clears all in-memory configuration caches.

Definition at line 181 of file class.module.php.

    {
        self::$configCache = array();
    }

Referenced by CacheManager\clearAll().

Here is the caller graph for this function:

◆ getId()

getId ( )

Gets the ID of the module.

Returns: string The ID of the module.

Definition at line 235 of file class.module.php.

    {
        return $this->id;
    }

References $id.

◆ getName()

getName ( )

Gets the name of the module.

Returns: string The name of the module.

Definition at line 245 of file class.module.php.

    {
        return $this->name;
    }

References $name.

Referenced by __toString(), BinApache\changePort(), BinMailpit\changePort(), BinMariadb\changePort(), BinMemcached\changePort(), BinMysql\changePort(), BinPostgresql\changePort(), BinXlight\changePort(), BinApache\checkPort(), BinMailpit\checkPort(), BinMariadb\checkPort(), BinMemcached\checkPort(), BinMysql\checkPort(), BinPostgresql\checkPort(), BinXlight\checkPort(), BinPostgresql\handleNonPostgresUsage(), BinApache\reload(), BinMailpit\reload(), BinMariadb\reload(), BinMemcached\reload(), BinMysql\reload(), BinPostgresql\reload(), BinXlight\reload(), BinApache\setEnable(), BinMailpit\setEnable(), BinMariadb\setEnable(), BinMemcached\setEnable(), BinMysql\setEnable(), BinNodejs\setEnable(), BinPhp\setEnable(), BinPostgresql\setEnable(), BinXlight\setEnable(), AppPhpmyadmin\updateConfig(), AppPhppgadmin\updateConfig(), BinApache\updateConfig(), BinMailpit\updateConfig(), BinMariadb\updateConfig(), BinMemcached\updateConfig(), BinMysql\updateConfig(), BinNodejs\updateConfig(), BinPhp\updateConfig(), BinPostgresql\updateConfig(), and BinXlight\updateConfig().

Here is the caller graph for this function:

◆ getRelease()

getRelease ( )

Gets the release information of the module.

Returns: string The release information.

Definition at line 282 of file class.module.php.

    {
        return $this->release;
    }

References $release.

◆ getType()

getType ( )

Gets the type of the module.

Returns: string The type of the module.

Definition at line 225 of file class.module.php.

    {
        return $this->type;
    }

References $type.

◆ getVersion()

getVersion ( )

Gets the version of the module.

Returns: string The version of the module.

Definition at line 255 of file class.module.php.

    {
        return $this->version;
    }

References $version.

Referenced by BinPhp\getApacheModule(), BinApache\getOfflineContent(), BinApache\getOnlineContent(), BinPhp\getTsDll(), BinMariadb\initData(), BinMysql\initData(), BinApache\setEnable(), BinMailpit\setEnable(), BinMariadb\setEnable(), BinMemcached\setEnable(), BinMysql\setEnable(), BinNodejs\setEnable(), BinPhp\setEnable(), BinPostgresql\setEnable(), BinXlight\setEnable(), BinApache\updateConfig(), BinMailpit\updateConfig(), BinMariadb\updateConfig(), BinMemcached\updateConfig(), BinMysql\updateConfig(), BinNodejs\updateConfig(), BinPhp\updateConfig(), BinPostgresql\updateConfig(), and BinXlight\updateConfig().

Here is the caller graph for this function:

◆ getVersionList()

getVersionList ( )

Gets the list of available versions for the module.

Returns: array The list of available versions.

Definition at line 265 of file class.module.php.

    {
        return Util::getVersionList($this->rootPath);
    }

References Util\getVersionList().

Referenced by BinPhp\getApacheModule().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ invalidateConfigCacheForPath()

invalidateConfigCacheForPath ( $sourcePath )

static

Invalidates the configuration cache for a given source path. Clears both in-memory cache and disk cache via CacheManager.

Parameters

string $sourcePath The path to the configuration file to invalidate cache for.

Definition at line 171 of file class.module.php.

    {
        $cacheKey = md5($sourcePath);
        unset(self::$configCache[$cacheKey]);
        CacheManager::invalidate($sourcePath);
    }

References CacheManager\invalidate().

Referenced by BinApache\replaceAll(), BinMailpit\replaceAll(), BinMariadb\replaceAll(), BinMemcached\replaceAll(), BinMysql\replaceAll(), BinPostgresql\replaceAll(), BinXlight\replaceAll(), replaceAll(), and BinMysql\updateConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isEnable()

isEnable ( )

Checks if the module is enabled.

Returns: bool True if the module is enabled, false otherwise.

Definition at line 293 of file class.module.php.

    {
        return $this->enable;
    }

References $enable.

◆ reload()

reload	(		$id = null,
			$type = null )

protected

Reloads the module configuration based on the provided ID and type.

Parameters

string \| null	$id	The ID of the module. If null, the current ID is used.
string \| null	$type	The type of the module. If null, the current type is used.

Reimplemented in AppPhpmyadmin, AppPhppgadmin, BinApache, BinMailpit, BinMariadb, BinMemcached, BinMysql, BinNodejs, BinPhp, BinPostgresql, BinXlight, ToolBruno, ToolComposer, ToolGhostscript, ToolGit, ToolNgrok, ToolPerl, ToolPowerShell, ToolPython, and ToolRuby.

Definition at line 67 of file class.module.php.

    {
        global $bearsamppRoot;
 
        $this->id   = empty($id) ? $this->id : $id;
        $this->type = empty($type) ? $this->type : $type;
        $mainPath   = 'N/A';
 
        switch ($this->type) {
            case Apps::TYPE:
                $mainPath = Path::getAppsPath();
                break;
            case Bins::TYPE:
                $mainPath = Path::getBinPath();
                break;
            case Tools::TYPE:
                $mainPath = Path::getToolsPath();
                break;
        }
 
        $this->rootPath      = $mainPath . '/' . $this->id;
        $this->currentPath   = $this->rootPath . '/' . $this->id . $this->version;
        $this->symlinkPath   = $this->rootPath . '/current';
        $this->enable        = is_dir($this->currentPath);
        $this->bearsamppConf = $this->currentPath . '/bearsampp.conf';
 
        $cacheKey = md5($this->bearsamppConf);
        if (!isset(self::$configCache[$cacheKey])) {
            // CacheManager handles both disk cache and parsing
            $data = CacheManager::load(
                $this->bearsamppConf,
                function ($path) {
                    return @parse_ini_file($path) ?: [];
                },
                $cacheKey
            );
 
            if (!empty($data)) {
                $this->bearsamppConfRaw       = $data;
                self::$configCache[$cacheKey] = $this->bearsamppConfRaw;
            } else {
                $this->bearsamppConfRaw = [];
                // Do not cache empty results in memory to allow retry on next reload
            }
        } else {
            $this->bearsamppConfRaw = self::$configCache[$cacheKey];
        }
 
        if (!Symlinks::isSkippingSymlinkCreation()) {
            Symlinks::createModuleSymlink($this);
        }
    }

References $bearsamppConfRaw, $bearsamppRoot, $id, $type, $version, Symlinks\createModuleSymlink(), Path\getAppsPath(), Path\getBinPath(), Path\getToolsPath(), Symlinks\isSkippingSymlinkCreation(), CacheManager\load(), Apps\TYPE, Bins\TYPE, and Tools\TYPE.

Here is the call graph for this function:

◆ replace()

replace	(		$key,
			$value )

protected

Replaces a specific key-value pair in the configuration file.

Parameters

string	$key	The key to replace.
string	$value	The new value for the key.

Definition at line 127 of file class.module.php.

    {
        $this->replaceAll(array($key => $value));
    }

References replaceAll().

Referenced by BinMailpit\setListen(), BinMemcached\setMemory(), BinApache\setPort(), BinMariadb\setPort(), BinMemcached\setPort(), BinMysql\setPort(), BinPostgresql\setPort(), BinXlight\setPort(), BinMariadb\setRootPwd(), BinMysql\setRootPwd(), BinPostgresql\setRootPwd(), BinMariadb\setRootUser(), BinMysql\setRootUser(), BinPostgresql\setRootUser(), BinMailpit\setSmtpPort(), BinApache\setSslPort(), BinXlight\setSslPort(), BinMailpit\setUiPort(), and BinMailpit\setWebRoot().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ replaceAll()

replaceAll ( $params )

protected

Replaces multiple key-value pairs in the configuration file.

Parameters

array $params An associative array of key-value pairs to replace.

Exceptions

RuntimeException If the configuration key or value is invalid.

Reimplemented in BinApache, BinMailpit, BinMariadb, BinMemcached, BinMysql, BinPostgresql, and BinXlight.

Definition at line 139 of file class.module.php.

    {
        $content = file_get_contents($this->bearsamppConf);
 
        foreach ($params as $key => $value) {
            // Same hardening as Config::replaceAll() - the key is used in a
            // regex pattern and the value in the INI content, so both must be
            // validated to prevent config poisoning.
            if (!is_string($key) || preg_match('/^[a-zA-Z0-9_-]+$/', $key) !== 1) {
                throw new RuntimeException('Invalid configuration key: ' . var_export($key, true));
            }
            $value = (string)$value;
            if (preg_match('/[\r\n"\x00-\x1F\x7F]/', $value) === 1) {
                throw new RuntimeException('Invalid configuration value for key: ' . $key);
            }
 
            $content                      = preg_replace('|' . preg_quote($key, '|') . ' = .*|', $key . ' = ' . '"' . $value . '"', $content);
            $this->bearsamppConfRaw[$key] = $value;
        }
 
        file_put_contents($this->bearsamppConf, $content);
 
        // Invalidate both memory cache and disk cache
        self::invalidateConfigCacheForPath($this->bearsamppConf);
    }

References invalidateConfigCacheForPath().

Referenced by replace().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setVersion()

setVersion ( $version )

abstract

Sets the version of the module.

Parameters

string $version The version to set.

Reimplemented in AppPhpmyadmin, AppPhppgadmin, BinApache, BinMailpit, BinMariadb, BinMemcached, BinMysql, BinNodejs, BinPhp, BinPostgresql, BinXlight, ToolBruno, ToolComposer, ToolGhostscript, ToolGit, ToolNgrok, ToolPerl, ToolPowerShell, ToolPython, and ToolRuby.

References $version.

◆ update()

update	(		$sub = 0,
			$showWindow = false )

Updates the module configuration.

Parameters

int	$sub	The sub-level for logging indentation.
bool	$showWindow	Whether to show a window during the update process.

Definition at line 192 of file class.module.php.

    {
        $this->updateConfig(null, $sub, $showWindow);
    }

References updateConfig().

Referenced by BinApache\changePort(), BinMailpit\changePort(), BinMariadb\changePort(), BinMemcached\changePort(), BinMysql\changePort(), BinPostgresql\changePort(), BinXlight\changePort(), BinMariadb\changeRootPassword(), BinMysql\changeRootPassword(), and BinPostgresql\changeRootPassword().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateConfig()

updateConfig	(	$version = null,
		$sub = 0,
		$showWindow = false )

protected

Updates the module configuration with a specific version.

Parameters

string \| null	$version	The version to update to. If null, the current version is used.
int	$sub	The sub-level for logging indentation.
bool	$showWindow	Whether to show a window during the update process.

Reimplemented in AppPhpmyadmin, AppPhppgadmin, BinApache, BinMailpit, BinMariadb, BinMemcached, BinMysql, BinNodejs, BinPhp, BinPostgresql, BinXlight, and ToolGit.

Definition at line 204 of file class.module.php.

    {
        $version = $version == null ? $this->version : $version;
        Log::debug(($sub > 0 ? str_repeat(' ', 2 * $sub) : '') . 'Update ' . $this->name . ' ' . $version . ' config');
    }

References $version, and Log\debug().

Referenced by update().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $bearsamppConf

$bearsamppConf

protected

Definition at line 47 of file class.module.php.

Referenced by BinPhp\getApacheModule(), BinApache\updateConfig(), BinMailpit\updateConfig(), BinMariadb\updateConfig(), BinMemcached\updateConfig(), BinMysql\updateConfig(), BinNodejs\updateConfig(), BinPhp\updateConfig(), BinPostgresql\updateConfig(), and BinXlight\updateConfig().

◆ $bearsamppConfRaw

$bearsamppConfRaw

protected

Definition at line 50 of file class.module.php.

Referenced by reload(), BinApache\updateConfig(), BinMailpit\updateConfig(), BinMariadb\updateConfig(), BinMemcached\updateConfig(), BinMysql\updateConfig(), BinNodejs\updateConfig(), BinPhp\updateConfig(), BinPostgresql\updateConfig(), and BinXlight\updateConfig().

◆ $configCache

$configCache = array()

staticprivate

Definition at line 17 of file class.module.php.

◆ $currentPath

$currentPath

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

Referenced by BinPhp\getApacheModule(), BinPhp\getTsDll(), BinMysql\updateConfig(), and BinPostgresql\updateConfig().

◆ $enable

$enable

protected

Definition at line 44 of file class.module.php.

Referenced by isEnable().

◆ $id

$id

private

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

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

◆ $name

$name

protected

Definition at line 26 of file class.module.php.

Referenced by BinApache\getAliasContent(), BinPhp\getExtensionsFromConf(), BinPhp\getExtensionsFromFolder(), BinPhp\getExtensionsLoaded(), BinApache\getModulesFromConf(), BinApache\getModulesFromFolder(), BinApache\getModulesLoaded(), getName(), BinPhp\isSettingActive(), and BinPhp\isSettingExists().

◆ $release

$release = 'N/A'

protected

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

Referenced by getRelease().

◆ $rootPath

$rootPath

Definition at line 35 of file class.module.php.

◆ $symlinkPath

$symlinkPath

Definition at line 41 of file class.module.php.

◆ $type

$type

private

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

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

◆ $version

$version

protected

Definition at line 29 of file class.module.php.

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

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

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ clearMemoryCache()

◆ getId()

◆ getName()

◆ getRelease()

◆ getType()

◆ getVersion()

◆ getVersionList()

◆ invalidateConfigCacheForPath()

◆ isEnable()

◆ reload()

◆ replace()

◆ replaceAll()

◆ setVersion()

◆ update()

◆ updateConfig()

Field Documentation

◆ $bearsamppConf

◆ $bearsamppConfRaw

◆ $configCache

◆ $currentPath

◆ $enable

◆ $id

◆ $name

◆ $release

◆ $rootPath

◆ $symlinkPath

◆ $type

◆ $version