Str

About 3 min

Str

The Str utility class.

This class contains a collection of static methods for working with strings.

Properties

reservedKeywords

private array $reservedKeywords = array (
  0 => '__halt_compiler',
  1 => 'abstract',
  2 => 'and',
  3 => 'array',
  4 => 'as',
  5 => 'break',
  6 => 'callable',
  7 => 'case',
  8 => 'catch',
  9 => 'class',
  10 => 'clone',
  11 => 'const',
  12 => 'continue',
  13 => 'declare',
  14 => 'default',
  15 => 'die',
  16 => 'do',
  17 => 'echo',
  18 => 'else',
  19 => 'elseif',
  20 => 'empty',
  21 => 'enddeclare',
  22 => 'endfor',
  23 => 'endforeach',
  24 => 'endif',
  25 => 'endswitch',
  26 => 'endwhile',
  27 => 'eval',
  28 => 'exit',
  29 => 'extends',
  30 => 'final',
  31 => 'for',
  32 => 'foreach',
  33 => 'function',
  34 => 'global',
  35 => 'goto',
  36 => 'if',
  37 => 'implements',
  38 => 'include',
  39 => 'include_once',
  40 => 'instanceof',
  41 => 'insteadof',
  42 => 'interface',
  43 => 'isset',
  44 => 'list',
  45 => 'namespace',
  46 => 'new',
  47 => 'or',
  48 => 'print',
  49 => 'private',
  50 => 'protected',
  51 => 'public',
  52 => 'require',
  53 => 'require_once',
  54 => 'return',
  55 => 'static',
  56 => 'switch',
  57 => 'throw',
  58 => 'trait',
  59 => 'try',
  60 => 'unset',
  61 => 'use',
  62 => 'var',
  63 => 'while',
  64 => 'xor',
)

reservedConstants

private array $reservedConstants = array (
  0 => '__CLASS__',
  1 => '__DIR__',
  2 => '__FILE__',
  3 => '__FUNCTION__',
  4 => '__LINE__',
  5 => '__METHOD__',
  6 => '__NAMESPACE__',
  7 => '__TRAIT__',
)

Methods

fromBytes

Byte to string formatter.

public fromBytes(int $bytes, ?string $type, ?int $precision, bool $excludeSuffix): void

Formats an integer representing a size in bytes to a human readable string representation.

The $type can be on of:

B (bytes)
K (kilobytes)
M (megabytes)
G (giabytes)
T (terrabytes)

If the $type is not provided, the function will automatically determine the best type to use based on the size of the byte value.

Parameters

Parameter	Type	Description
`$bytes`	`int`	the byte value to convert to a string
`$type`	`string`	The type to convert to. Type can be:
`$precision`	`int`	the number of decimal places to show
`$excludeSuffix`	`bool`	if true, the suffix will not be included in the output

toBytes

String to bytes formatter.

public toBytes(string $string): float

Returns an integer value representing a number of bytes from the standard bytes size string supplied.

Parameters

Parameter	Type	Description
`$string`	`string`	The byte string value to convert to an integer. eg: '100MB'

fixtype

Fix a numeric string.

public fixtype(mixed $value): int

Sometimes a numeric (int or float) will be stored as a string variable. This can cause issues with functions that check the variable type to determine what to do with it. This function allows you to simply pass a variable through it and it will 'fix' it. If it is a string and is a numeric value, it will be converted to the appropriate variable type.

If the value is a string and is meant to be a string, it will be left alone.

Parameters

Parameter	Type	Description
`$value`	`mixed`	the variable to type check and possibly fix

guid

Generates a globally unique identifier (GUID) in the format 'xxxxxxxx-yxxx-yxxx-yxxx-xxxxxxxxxxxx'.

public guid(): string

The GUID is generated using a combination of random numbers and specific formatting rules. The 'x' characters are replaced with random hexadecimal digits (0-9, a-f). The 'y' characters are replaced with random hexadecimal digits from the set (8, 9, a, b).

pregMatchArray

Perform a regular expression match on a string using multiple possible regular expressions.

public pregMatchArray(string $patterns, string $subject, ?array $matches, mixed $flags, int $offset): int

This is the same as calling preg_match() except that $patterns is an array of regular expressions. Execution returns on the first match.

Parameters

Parameter	Type	Description
`$patterns`	`string`	an array of patterns to search for, as a string
`$subject`	`string`	the input string
`$matches`	`array`	If matches is provided, then it is filled with the results of search. $matches[0] will contain the text that matched the full pattern, $matches[1] will have the text that matched the first captured parenthesized subpattern, and so on.
`$flags`	`mixed`	For details on available flags, see the preg_match() documentation.
`$offset`	`int`	Normally, the search starts from the beginning of the subject string. The optional parameter offset can be used to specify the alternate place from which to start the search (in bytes).

putCSV

Convert an array into a CSV line.

public putCSV(array $input, string $delimiter = ',', string $enclosure = '"', string $escapeChar = '\\'): string

Parameters

Parameter	Type	Description
`$input`	`array`	The array to convert to a CSV line
`$delimiter`	`string`	Defaults to comma (,)
`$enclosure`	`string`	Defaults to double quote (")
`$escapeChar`	`string`

random

Generate a truly random string of characters.

public random(mixed $length, boolean $includeSpecial): void

Parameters

Parameter	Type	Description
`$length`	`mixed`	the length of the random string being created
`$includeSpecial`	`boolean`	Whether or not special characters. Normally only Aa-Zz, 0-9 are used. If TRUE will include characters such as #, $, etc. This can also be a string of characters to use.

matchReplace

Use the match/replace algorithm on a string to replace mustache tags with view data.

public matchReplace(string $string, mixed $data, boolean $strict): void

This is similar code used in the Smarty view template renderer.

So strings such as:

Hello, {{entity}} will replace with the value of $data->entity.
The quick brown {{animal.one}}, jumped over the lazy {{animal.two}} will replace the tags with values in a multi-dimensional array.

Parameters

Parameter	Type	Description
`$string`	`string`	the string to perform the match/replace on
`$data`	`mixed`	the data to use for matching
`$strict`	`boolean`	in strict mode, the function will return NULL if any of the matches are do not exist in data or are NULL

isReserved

Checks if a given word is a reserved keyword or constant.

public isReserved(string $word): bool

This method converts the input word to both lowercase and uppercase, and checks if it exists in the list of reserved keywords or constants.

Parameters

Parameter	Type	Description
`$word`	`string`	the word to check

Generated by Hazaar API Doc Generator