Registry Class Reference

Public Member Functions
	__construct ()
	deleteValue ($key, $subkey, $entry)
	exists ($key, $subkey, $entry=null)
	getLatestError ()
	getValue ($key, $subkey, $entry=null)
	setExpandStringValue ($key, $subkey, $entry, $value)
	setStringValue ($key, $subkey, $entry, $value)

Data Fields
const	APP_BINS_REG_ENTRY = 'BEARSAMPP_BINS'
const	APP_PATH_REG_ENTRY = 'BEARSAMPP_PATH'
const	END_PROCESS_STR = 'FINISHED!'
const	ENV_KEY = 'SYSTEM\CurrentControlSet\Control\Session Manager\Environment'
const	HKEY_CLASSES_ROOT = 'HKCR'
const	HKEY_CURRENT_USER = 'HKCU'
const	HKEY_LOCAL_MACHINE = 'HKLM'
const	HKEY_USERS = 'HKEY_USERS'
const	PROCESSOR_REG_ENTRY = 'Identifier'
const	PROCESSOR_REG_SUBKEY = 'HARDWARE\DESCRIPTION\System\CentralProcessor\0'
const	REG_BINARY = 'REG_BINARY'
const	REG_DWORD = 'REG_DWORD'
const	REG_ERROR_ENTRY = 'REG_ERROR_ENTRY'
const	REG_ERROR_SET = 'REG_ERROR_SET'
const	REG_EXPAND_SZ = 'REG_EXPAND_SZ'
const	REG_MULTI_SZ = 'REG_MULTI_SZ'
const	REG_NO_ERROR = 'REG_NO_ERROR'
const	REG_SZ = 'REG_SZ'
const	SYSPATH_REG_ENTRY = 'Path'

Private Member Functions
	setValue ($key, $subkey, $entry, $value, $type)
	writeLog ($log)

Private Attributes
	$latestError

Detailed Description

Class Registry

This class provides methods to interact with the Windows Registry using COM. It includes functionalities to check the existence of registry keys, get and set values, and delete registry entries. The class also logs operations and errors.

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

Constructor & Destructor Documentation

__construct()

__construct

(

)

Registry constructor. Initializes the Registry class and logs the initialization.

Definition at line 57 of file class.registry.php.

    {
        Log::initClass($this);
        $this->latestError = null;
    }

References Log\initClass().

Member Function Documentation

deleteValue()

deleteValue	(		$key,
			$subkey,
			$entry )

Deletes a registry entry.

Parameters

string	$key	The root key (e.g., HKEY_LOCAL_MACHINE).
string	$subkey	The subkey path.
string	$entry	The entry name.

Returns

bool True if the entry was deleted successfully, false otherwise.

Definition at line 161 of file class.registry.php.

    {
        $this->writeLog('delete');
        return $this->setValue($key, $subkey, $entry, null, 'DeleteValue');
    }

References setValue(), and writeLog().

exists()

exists	(		$key,
			$subkey,
			$entry = null )

Checks if a registry key or entry exists. Now uses Win32Native COM methods instead of VBScript.

Parameters

string	$key	The root key (e.g., HKEY_LOCAL_MACHINE).
string	$subkey	The subkey path.
string | null	$entry	The entry name (optional).

Returns

bool True if the key or entry exists, false otherwise.

Definition at line 83 of file class.registry.php.

    {
        $this->writeLog('Exists ' . $key . '\\' . $subkey . '\\' . $entry);
 
        // Use Win32Native COM implementation
        $result = Win32Native::registryExists($key, $subkey, $entry);
 
        $this->writeLog('-> result: ' . ($result ? '1' : '0'));
 
        return $result;
    }

References $result, Win32Native\registryExists(), and writeLog().

getLatestError()

getLatestError

(

)

Retrieves the latest error message.

Returns

string|null The latest error message, or null if no error occurred.

Definition at line 236 of file class.registry.php.

    {
        return $this->latestError;
    }

References $latestError.

getValue()

getValue	(		$key,
			$subkey,
			$entry = null )

Retrieves the value of a registry entry. Now uses Win32Native COM methods instead of VBScript.

Parameters

string	$key	The root key (e.g., HKEY_LOCAL_MACHINE).
string	$subkey	The subkey path.
string | null	$entry	The entry name (optional).

Returns

mixed The value of the registry entry, or false on error.

Definition at line 104 of file class.registry.php.

    {
        global $bearsamppLang;
 
        $this->latestError = null;
 
        $this->writeLog('GetValue ' . $key . '\\' . $subkey . '\\' . $entry);
 
        // Use Win32Native COM implementation
        $result = Win32Native::registryGetValue($key, $subkey, $entry);
 
        $this->writeLog('-> result: ' . $result);
 
        if ($result === null) {
            $this->latestError = $bearsamppLang->getValue(Lang::ERROR) . ' Registry value not found';
            return false;
        }
 
        return $result;
    }

References $bearsamppLang, $result, Lang\ERROR, Win32Native\registryGetValue(), and writeLog().

setExpandStringValue()

setExpandStringValue	(		$key,
			$subkey,
			$entry,
			$value )

Sets an expanded string value in the registry.

Parameters

string	$key	The root key (e.g., HKEY_LOCAL_MACHINE).
string	$subkey	The subkey path.
string	$entry	The entry name.
string	$value	The value to set.

Returns

bool True if the value was set successfully, false otherwise.

Definition at line 148 of file class.registry.php.

    {
        return $this->setValue($key, $subkey, $entry, $value, 'SetExpandedStringValue');
    }

References setValue().

setStringValue()

setStringValue	(		$key,
			$subkey,
			$entry,
			$value )

Sets a string value in the registry.

Parameters

string	$key	The root key (e.g., HKEY_LOCAL_MACHINE).
string	$subkey	The subkey path.
string	$entry	The entry name.
string	$value	The value to set.

Returns

bool True if the value was set successfully, false otherwise.

Definition at line 134 of file class.registry.php.

    {
        return $this->setValue($key, $subkey, $entry, $value, 'SetStringValue');
    }

References setValue().

setValue()

setValue ( $key, $subkey, $entry, $value, $type )

private

Sets a value in the registry. Now uses Win32Native COM methods instead of VBScript.

Parameters

string	$key	The root key (e.g., HKEY_LOCAL_MACHINE).
string	$subkey	The subkey path.
string	$entry	The entry name.
string | null	$value	The value to set (optional).
string	$type	The type of value to set (e.g., SetStringValue).

Returns

bool True if the value was set successfully, false otherwise.

Definition at line 178 of file class.registry.php.

    {
        global $bearsamppLang;
 
        $this->latestError = null;
 
        $this->writeLog('SetValue ' . $key . '\\' . $subkey . '\\' . $entry);
        $this->writeLog('-> value: ' . $value);
        $this->writeLog('-> type: ' . $type);
 
        // Map the VBS type to Win32Native registry type
        $regType = self::REG_SZ; // Default
        if ($type == 'SetExpandedStringValue') {
            $regType = self::REG_EXPAND_SZ;
        } elseif ($type == 'SetStringValue') {
            $regType = self::REG_SZ;
        }
 
        // Handle delete operations
        if ($type == 'DeleteValue' && !empty($entry)) {
            // Delete a value
            $result = Win32Native::registryDeleteValue($key, $subkey, $entry);
        } elseif ($type == 'DeleteValue' && empty($entry)) {
            // Delete a key
            $result = Win32Native::registryDeleteKey($key, $subkey);
        } else {
            // Set a value
            $result = Win32Native::registrySetValue($key, $subkey, $entry, $value, $regType);
        }
 
        if ($subkey == self::ENV_KEY) {
            Batch::refreshEnvVars();
        }
 
        $this->writeLog('-> result: ' . ($result ? 'success' : 'failed'));
 
        if (!$result) {
            $this->latestError = $bearsamppLang->getValue(Lang::ERROR) . ' Registry operation failed';
            return false;
        }
 
        // Verify the value was set correctly (for set operations)
        if ($type != 'DeleteValue' && !empty($value)) {
            $verifyValue = Win32Native::registryGetValue($key, $subkey, $entry);
            if ($verifyValue != $value) {
                $this->latestError = sprintf($bearsamppLang->getValue(Lang::REGISTRY_SET_ERROR_TEXT), $value);
                return false;
            }
        }
 
        return true;
    }

References $bearsamppLang, $result, Lang\ERROR, Batch\refreshEnvVars(), Lang\REGISTRY_SET_ERROR_TEXT, Win32Native\registryDeleteKey(), Win32Native\registryDeleteValue(), Win32Native\registryGetValue(), Win32Native\registrySetValue(), and writeLog().

Referenced by deleteValue(), setExpandStringValue(), and setStringValue().

writeLog()

writeLog ( $log )

private

Writes a log entry.

Parameters

string

$log

The log message to write.

Definition at line 68 of file class.registry.php.

    {
        global $bearsamppRoot;
        Log::debug($log, $bearsamppRoot->getRegistryLogFilePath());
    }

References $bearsamppRoot, and Log\debug().

Referenced by deleteValue(), exists(), getValue(), and setValue().

Field Documentation

$latestError

$latestError

private

Definition at line 51 of file class.registry.php.

Referenced by getLatestError().

APP_BINS_REG_ENTRY

const APP_BINS_REG_ENTRY = 'BEARSAMPP_BINS'

Definition at line 39 of file class.registry.php.

Referenced by ActionStartup\checkBinsRegKey(), ActionStartup\checkSystemPathRegKey(), Util\getAppBinsRegKey(), ActionSwitchVersion\processWindow(), and Util\setAppBinsRegKey().

APP_PATH_REG_ENTRY

const APP_PATH_REG_ENTRY = 'BEARSAMPP_PATH'

Definition at line 42 of file class.registry.php.

Referenced by ActionStartup\checkPathRegKey(), Util\getAppPathRegKey(), Batch\refreshEnvVars(), and Util\setAppPathRegKey().

END_PROCESS_STR

const END_PROCESS_STR = 'FINISHED!'

Definition at line 19 of file class.registry.php.

ENV_KEY

const ENV_KEY = 'SYSTEM\CurrentControlSet\Control\Session Manager\Environment'

Definition at line 36 of file class.registry.php.

Referenced by Util\getAppBinsRegKey(), Util\getAppPathRegKey(), Util\getSysPathRegKey(), Util\setAppBinsRegKey(), Util\setAppPathRegKey(), and Util\setSysPathRegKey().

HKEY_CLASSES_ROOT

const HKEY_CLASSES_ROOT = 'HKCR'

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

HKEY_CURRENT_USER

const HKEY_CURRENT_USER = 'HKCU'

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

HKEY_LOCAL_MACHINE

const HKEY_LOCAL_MACHINE = 'HKLM'

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

Referenced by ActionStartup\cleanOldBehaviors(), Util\getAppBinsRegKey(), Util\getAppPathRegKey(), Util\getProcessorRegKey(), Util\getSysPathRegKey(), Nssm\infos(), BinMailpit\rebuildConf(), BinMemcached\rebuildConf(), BinXlight\rebuildConf(), Util\setAppBinsRegKey(), Util\setAppPathRegKey(), and Util\setSysPathRegKey().

HKEY_USERS

const HKEY_USERS = 'HKEY_USERS'

Definition at line 24 of file class.registry.php.

PROCESSOR_REG_ENTRY

const PROCESSOR_REG_ENTRY = 'Identifier'

Definition at line 49 of file class.registry.php.

Referenced by Util\getProcessorRegKey().

PROCESSOR_REG_SUBKEY

const PROCESSOR_REG_SUBKEY = 'HARDWARE\DESCRIPTION\System\CentralProcessor\0'

Definition at line 48 of file class.registry.php.

Referenced by Util\getProcessorRegKey().

REG_BINARY

const REG_BINARY = 'REG_BINARY'

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

REG_DWORD

const REG_DWORD = 'REG_DWORD'

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

REG_ERROR_ENTRY

const REG_ERROR_ENTRY = 'REG_ERROR_ENTRY'

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

REG_ERROR_SET

const REG_ERROR_SET = 'REG_ERROR_SET'

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

REG_EXPAND_SZ

const REG_EXPAND_SZ = 'REG_EXPAND_SZ'

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

REG_MULTI_SZ

const REG_MULTI_SZ = 'REG_MULTI_SZ'

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

REG_NO_ERROR

const REG_NO_ERROR = 'REG_NO_ERROR'

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

REG_SZ

const REG_SZ = 'REG_SZ'

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

SYSPATH_REG_ENTRY

const SYSPATH_REG_ENTRY = 'Path'

Definition at line 45 of file class.registry.php.

Referenced by ActionStartup\checkSystemPathRegKey(), Util\getSysPathRegKey(), and Util\setSysPathRegKey().

---

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

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