Inheritance diagram for Module:

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

Data Fields
const	BUNDLE_RELEASE = 'bundleRelease'

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
	$currentPath
	$enable
	$name
	$release = 'N/A'
	$rootPath
	$symlinkPath
	$version

Private Member Functions
	createSymlink ()

Private Attributes
	$id
	$type

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 36 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 165 of file class.module.php.

                                 {
        return $this->getName();
    }

References getName().

◆ createSymlink()

createSymlink ( )

private

Creates a symbolic link from the current path to the symlink path. If the symlink already exists and points to the correct target, no action is taken.

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

    {
        $src = UtilPath::formatWindowsPath($this->currentPath);
        $dest = UtilPath::formatWindowsPath($this->symlinkPath);
 
        if(file_exists($dest)) {
            if (is_link($dest)) {
                $target = readlink($dest);
                if ($target == $src) {
                    return;
                }
                Batch::removeSymlink($dest);
            } elseif (is_file($dest)) {
                Log::error('Removing . ' . $this->symlinkPath . ' file. It should not be a regular file');
                unlink($dest);
            } elseif (is_dir($dest)) {
                // Never recursively delete here: this path is expected to be a symlink.
                // Only remove empty directories; otherwise abort to avoid data loss.
                $it = new \FilesystemIterator($dest);
                if (!$it->valid()) {
                    rmdir($dest);
                } else {
                    Log::error($this->symlinkPath . ' should be a symlink to ' . $this->currentPath . '. Please remove this dir and restart bearsampp.');
                    return;
                }
            }
        }
 
        Batch::createSymlink($src, $dest);
    }

References Batch\createSymlink(), Log\error(), UtilPath\formatWindowsPath(), and Batch\removeSymlink().

Referenced by reload().

◆ getCurrentPath()

getCurrentPath ( )

Gets the current path of the module.

Returns: string The current path of the module.

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

                                     {
        return $this->currentPath;
    }

References $currentPath.

Referenced by BinPhp\getApacheModule(), BinPhp\getExtensionsFromFolder(), BinPhp\getPearVersion(), BinPhp\getTsDll(), BinMariadb\initData(), BinMysql\initData(), BinPostgresql\initData(), BinMysql\updateConfig(), and BinPostgresql\updateConfig().

◆ getId()

getId ( )

Gets the ID of the module.

Returns: string The ID of the module.

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

◆ getRelease()

getRelease ( )

Gets the release information of the module.

Returns: string The release information.

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

                                 {
        return $this->release;
    }

References $release.

◆ getRootPath()

getRootPath ( )

Gets the root path of the module.

Returns: string The root path of the module.

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

                                  {
        return $this->rootPath;
    }

References $rootPath.

◆ getSymlinkPath()

getSymlinkPath ( )

Gets the symlink path of the module.

Returns: string The symlink path of the module.

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

                                     {
        return $this->symlinkPath;
    }

References $symlinkPath.

Referenced by AppPhpmyadmin\updateConfig(), AppPhppgadmin\updateConfig(), and ToolGit\updateConfig().

◆ getType()

getType ( )

Gets the type of the module.

Returns: string The type of the module.

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

◆ getVersionList()

getVersionList ( )

Gets the list of available versions for the module.

Returns: array The list of available versions.

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

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

References Util\getVersionList().

Referenced by BinPhp\getApacheModule().

◆ isEnable()

isEnable ( )

Checks if the module is enabled.

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

Definition at line 262 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 46 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 = $bearsamppRoot->getAppsPath();
                break;
            case Bins::TYPE:
                $mainPath = $bearsamppRoot->getBinPath();
                break;
            case Tools::TYPE:
                $mainPath = $bearsamppRoot->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';
        $this->bearsamppConfRaw = @parse_ini_file($this->bearsamppConf);
 
        if ($bearsamppRoot->isRoot()) {
            $this->createSymlink();
        }
    }

References $bearsamppRoot, $id, $type, $version, createSymlink(), Apps\TYPE, Bins\TYPE, and Tools\TYPE.

◆ 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 118 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().

◆ 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.

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

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

                                           {
        $content = file_get_contents($this->bearsamppConf);
 
        foreach ($params as $key => $value) {
            $content = preg_replace('|' . $key . ' = .*|', $key . ' = ' . '"' . $value.'"', $content);
            $this->bearsamppConfRaw[$key] = $value;
        }
 
        file_put_contents($this->bearsamppConf, $content);
    }

Referenced by replace().

◆ 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 144 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().

◆ 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 155 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().

Field Documentation

◆ $bearsamppConf

$bearsamppConf

protected

Definition at line 29 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 30 of file class.module.php.

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

◆ $currentPath

$currentPath

protected

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

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

◆ $enable

$enable

protected

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

Referenced by isEnable().

◆ $id

$id

private

Definition at line 19 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 21 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 23 of file class.module.php.

Referenced by getRelease().

◆ $rootPath

$rootPath

protected

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

Referenced by getRootPath().

◆ $symlinkPath

$symlinkPath

protected

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

Referenced by getSymlinkPath().

◆ $type

$type

private

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

◆ BUNDLE_RELEASE

const BUNDLE_RELEASE = 'bundleRelease'

Definition at line 16 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

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ createSymlink()

◆ getCurrentPath()

◆ getId()

◆ getName()

◆ getRelease()

◆ getRootPath()

◆ getSymlinkPath()

◆ getType()

◆ getVersion()

◆ getVersionList()

◆ isEnable()

◆ reload()

◆ replace()

◆ replaceAll()

◆ setVersion()

◆ update()

◆ updateConfig()

Field Documentation

◆ $bearsamppConf

◆ $bearsamppConfRaw

◆ $currentPath

◆ $enable

◆ $id

◆ $name

◆ $release

◆ $rootPath

◆ $symlinkPath

◆ $type

◆ $version

◆ BUNDLE_RELEASE