UtilString Class Reference

Static Public Member Functions
static	contains ($string, $search)
static	endWith ($string, $search)
static	generateSecureBytes ($length=32)
static	generateSecureToken ($length=32)
static	isAlphanumeric ($string)
static	random ($length=32, $withNumeric=true)
static	startWith ($string, $search)

Detailed Description

String utility methods and cryptographically secure random generators.

Provides case-insensitive substring checks, prefix/suffix tests, alphanumeric validation, and secure random string/token/bytes generation.

Note: This class is required directly by the bootstrap (class.root.php) because the autoloader itself depends on UtilString\startWith().

Usage:

UtilString::startWith('foobar', 'foo'); // true
UtilString::random(16);                 // cryptographically secure random string

Definition at line 26 of file class.util.string.php.

Member Function Documentation

contains()

contains ( $string, $search )

static

Checks if a string contains a specified substring (case-insensitive).

Parameters

string	$string	The string to search in.
string	$search	The substring to search for.

Returns

bool Returns true if the substring is found, otherwise false.

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

    {
        if (!empty($string) && !empty($search)) {
            return stripos($string, $search) !== false;
        }
 
        return false;
    }

Referenced by BinMailpit\checkPort(), BinXlight\checkPort(), BinMariadb\getCmdLineOutput(), BinMysql\getCmdLineOutput(), Util\is32BitsOs(), and Win32Ps\killBins().

endWith()

endWith ( $string, $search )

static

Checks if a string ends with a specified substring.

Parameters

string	$string	The string to check.
string	$search	The substring to look for at the end of the string.

Returns

bool Returns true if the string ends with the search substring, otherwise false.

Definition at line 70 of file class.util.string.php.

    {
        $length = strlen($search);
        $start  = $length * -1;
 
        return (substr($string, $start) === $search);
    }

Referenced by Batch\exec(), Util\findFiles(), BinApache\getAlias(), BinPhp\getExtensionsFromFolder(), LangProc\getList(), TplAppLogs\getMenuLogs(), BinApache\getModulesFromFolder(), Batch\getProcessUsingPort(), and BinApache\getVhosts().

generateSecureBytes()

generateSecureBytes ( $length = 32 )

static

Generates a cryptographically secure random bytes string. Useful for encryption keys, initialization vectors, etc.

Parameters

int

$length

The length in bytes.

Returns

string Returns raw binary random bytes.

Exceptions

Exception

If an appropriate source of randomness cannot be found.

Definition at line 149 of file class.util.string.php.

    {
        try {
            return random_bytes($length);
        } catch (Exception $e) {
            Log::error('Failed to generate secure bytes: ' . $e->getMessage());
            throw $e;
        }
    }

References Log\error().

generateSecureToken()

generateSecureToken ( $length = 32 )

static

Generates a cryptographically secure random token as a hexadecimal string. Ideal for security tokens, session IDs, CSRF tokens, etc.

Parameters

int

$length

The length in bytes (output will be double this in hex characters).

Returns

string Returns a hexadecimal string of cryptographically secure random bytes.

Exceptions

Exception

If an appropriate source of randomness cannot be found.

Definition at line 130 of file class.util.string.php.

    {
        try {
            return bin2hex(random_bytes($length));
        } catch (Exception $e) {
            Log::error('Failed to generate secure token: ' . $e->getMessage());
            throw $e;
        }
    }

References Log\error().

isAlphanumeric()

isAlphanumeric ( $string )

static

Checks if a string is alphanumeric.

Parameters

string

$string

The string to check.

Returns

bool Returns true if the string is alphanumeric, false otherwise.

Definition at line 85 of file class.util.string.php.

    {
        return ctype_alnum($string);
    }

random()

random ( $length = 32, $withNumeric = true )

static

Generates a cryptographically secure random string of specified length and character set.

Parameters

int	$length	The length of the random string to generate.
bool	$withNumeric	Whether to include numeric characters in the random string.

Returns

string Returns the generated random string.

Exceptions

Exception

If an appropriate source of randomness cannot be found.

Definition at line 99 of file class.util.string.php.

    {
        $characters = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
        if ($withNumeric) {
            $characters .= '0123456789';
        }
 
        $charactersLength = strlen($characters);
        $randomString     = '';
 
        try {
            for ($i = 0; $i < $length; $i++) {
                $randomString .= $characters[random_int(0, $charactersLength - 1)];
            }
        } catch (Exception $e) {
            Log::error('Failed to generate cryptographically secure random string: ' . $e->getMessage());
            throw $e;
        }
 
        return $randomString;
    }

References Log\error().

Referenced by OpenSsl\createCrt(), and Batch\getTmpFile().

startWith()

startWith ( $string, $search )

static

Checks if a string starts with a specified substring.

Parameters

string	$string	The string to check.
string	$search	The substring to look for at the start of the string.

Returns

bool Returns true if the string starts with the search substring, otherwise false.

Definition at line 53 of file class.util.string.php.

    {
        if ($string === null || $string === '') {
            return false;
        }
 
        return (substr($string, 0, strlen($search)) === $search);
    }

Referenced by BinApache\checkPort(), BinMariadb\checkPort(), BinMysql\checkPort(), Util\findFiles(), BinApache\getModulesFromConf(), BinApache\getModulesFromFolder(), BinApache\getOfflineContent(), BinApache\getOnlineContent(), Batch\getOsInfo(), Batch\getPearVersion(), Batch\getProcessUsingPort(), BinApache\getVhostsUrl(), Win32Ps\killBins(), and Autoloader\resolveClassPath().

---

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

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