UtilPath Class Reference

Static Public Member Functions
static	clearPathFormatCache ()
static	formatUnixPath ($path)
static	formatWindowsPath ($path)
static	getPathFormatCacheSize ()
static	getPathFormatStats ()

Static Private Attributes
static	$pathFormatCache = []
static	$pathFormatCacheMaxSize = 500
static	$pathFormatStats

Detailed Description

Path formatting utilities with a write-through cache.

Converts between Windows (backslash) and Unix (forward-slash) path styles and caches the results to avoid redundant string replacements for frequently used paths such as root, bin, and tool paths.

Usage:

$win = UtilPath::formatWindowsPath('/some/unix/path');
$unix = UtilPath::formatUnixPath('C:\some\windows\path');

Definition at line 24 of file class.util.path.php.

Member Function Documentation

clearPathFormatCache()

clearPathFormatCache ( )

static

Clears the path format cache. Useful when paths change or for testing purposes.

Returns

void

Definition at line 142 of file class.util.path.php.

    {
        self::$pathFormatCache = [];
        self::$pathFormatStats = [
            'unix_hits'      => 0,
            'unix_misses'    => 0,
            'windows_hits'   => 0,
            'windows_misses' => 0,
        ];
    }

formatUnixPath()

formatUnixPath ( $path )

static

Converts a Windows-style path to a Unix-style path with caching. Unix-style paths use forward slashes (/) as separators.

Performance optimization: Caches results to avoid redundant string replacements for frequently used paths (e.g., root paths, bin paths).

Parameters

string

$path

The Windows-style path to convert.

Returns

string Returns the converted Unix-style path.

Definition at line 98 of file class.util.path.php.

    {
        if (empty($path)) {
            return $path;
        }
 
        $cacheKey = 'u_' . $path;
        if (isset(self::$pathFormatCache[$cacheKey])) {
            self::$pathFormatStats['unix_hits']++;
            return self::$pathFormatCache[$cacheKey];
        }
 
        self::$pathFormatStats['unix_misses']++;
 
        $result = str_replace('\\', '/', $path);
 
        if (count(self::$pathFormatCache) < self::$pathFormatCacheMaxSize) {
            self::$pathFormatCache[$cacheKey] = $result;
        } else {
            $removeCount = (int)(self::$pathFormatCacheMaxSize * 0.1);
            self::$pathFormatCache = array_slice(self::$pathFormatCache, $removeCount, null, true);
            self::$pathFormatCache[$cacheKey] = $result;
        }
 
        return $result;
    }

References $result.

Referenced by Util\changePath(), ActionQuit\checkForOrphanedProcesses(), Root\errorHandler(), Win32Ps\findByPath(), Util\findFile(), Util\findFiles(), Util\findRepos(), BinApache\getAliasContent(), BinApache\getVhostContent(), Win32Ps\killBins(), ActionStartup\killOldInstances(), ActionGenSslCertificate\processWindow(), ActionStartup\processWindow(), and ToolGit\reload().

formatWindowsPath()

formatWindowsPath ( $path )

static

Converts a Unix-style path to a Windows-style path with caching. This is a Windows application, so paths use backslashes () as separators.

Performance optimization: Caches results to avoid redundant string replacements for frequently used paths (e.g., root paths, bin paths).

Parameters

string

$path

The Unix-style path to convert.

Returns

string Returns the converted Windows-style path.

Definition at line 60 of file class.util.path.php.

    {
        if (empty($path)) {
            return $path;
        }
 
        $cacheKey = 'w_' . $path;
        if (isset(self::$pathFormatCache[$cacheKey])) {
            self::$pathFormatStats['windows_hits']++;
            return self::$pathFormatCache[$cacheKey];
        }
 
        self::$pathFormatStats['windows_misses']++;
 
        $result = str_replace('/', '\\', $path);
 
        if (count(self::$pathFormatCache) < self::$pathFormatCacheMaxSize) {
            self::$pathFormatCache[$cacheKey] = $result;
        } else {
            $removeCount = (int)(self::$pathFormatCacheMaxSize * 0.1);
            self::$pathFormatCache = array_slice(self::$pathFormatCache, $removeCount, null, true);
            self::$pathFormatCache[$cacheKey] = $result;
        }
 
        return $result;
    }

References $result.

Referenced by ActionGenSslCertificate\__construct(), Util\changePath(), ActionStartup\checkPathRegKey(), ActionAddVhost\createFormFields(), ActionEditAlias\createFormFields(), ActionEditVhost\createFormFields(), Batch\createSymlink(), Module\createSymlink(), Util\getAppBinsRegKey(), TplAestan\getItemPowerShell(), Nssm\getNssmEnvPaths(), ToolPowerShell\getShell(), Batch\getTmpFile(), BinMariadb\initData(), Batch\installPostgresqlService(), Batch\refreshEnvVars(), BinMariadb\reload(), Batch\removeSymlink(), Nssm\setBinPath(), Win32Service\setBinPath(), Nssm\setEnvironmentExtra(), and Batch\uninstallPostgresqlService().

getPathFormatCacheSize()

getPathFormatCacheSize ( )

static

Gets the current size of the path format cache.

Returns

int Number of cached path conversions.

Definition at line 158 of file class.util.path.php.

    {
        return count(self::$pathFormatCache);
    }

getPathFormatStats()

getPathFormatStats ( )

static

Gets path format cache statistics. Useful for monitoring cache effectiveness and tuning cache size.

Returns

array Array containing unix_hits, unix_misses, windows_hits, windows_misses.

Definition at line 131 of file class.util.path.php.

    {
        return self::$pathFormatStats;
    }

Field Documentation

$pathFormatCache

$pathFormatCache = []

staticprivate

Definition at line 30 of file class.util.path.php.

$pathFormatCacheMaxSize

$pathFormatCacheMaxSize = 500

staticprivate

Definition at line 36 of file class.util.path.php.

$pathFormatStats

$pathFormatStats

staticprivate

Initial value:

                                = [
    'unix_hits'      => 0,
    'unix_misses'    => 0,
    'windows_hits'   => 0,
    'windows_misses' => 0,
]

Definition at line 42 of file class.util.path.php.

---

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

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