StringHelper

Returns

Signature

public static string UUID ( )

# `arrayToString()`

Converts an array to a string.

Arguments

$arr (mixed)
$glue (string (opens new window))

Returns

Signature

public static string arrayToString ( $arr, $glue = ',' )

# `asciiString()`

Converts extended ASCII characters to ASCII.

Arguments

$str (string (opens new window))

Returns

Signature

public static string asciiString ( $str )

# `checkForIconv()`

Returns whether iconv is installed and not buggy.

Returns

Signature

public static boolean checkForIconv ( )

# `convertToUTF8()`

Attempts to convert a string to UTF-8 and clean any non-valid UTF-8 characters.

boolean (opens new window), string (opens new window)

Arguments

$string

Returns

Signature

public static boolean, string convertToUTF8 ( $string )

# `decdec()`

Base64-decodes and decrypts a string generated by {@link encenc()}.

Arguments

$str (string (opens new window)) – The string.

Returns

Signature

public static string decdec ( $str )

# `encenc()`

Encrypts and base64-encodes a string.

Arguments

$str (string (opens new window)) – The string.

Returns

Signature

public static string encenc ( $str )

# `encodeMb4()`

HTML-encodes any 4-byte UTF-8 characters.

See also http://stackoverflow.com/a/16496730/1688568 View source (opens new window)

Arguments

$string (string (opens new window)) – The string

Returns

string (opens new window) – The string with converted 4-byte UTF-8 characters

Signature

public static string encodeMb4 ( $string )

# `escapeCommas()`

Backslash-escapes any commas in a given string.

Arguments

$str (string (opens new window)) – The string.

Returns

Signature

public static string escapeCommas ( $str )

# `escapeRegexChars()`

Arguments

$string

Returns

mixed

Signature

public static mixed escapeRegexChars ( $string )

# `getAsciiCharMap()`

Returns ASCII character mappings.

Returns

array (opens new window)

Signature

public static array getAsciiCharMap ( )

# `getAsciiPunctuation()`

Returns the asciiPunctuation array.

Returns

array (opens new window)

Signature

public static array getAsciiPunctuation ( )

# `getCharAt()`

Returns the character at a specific point in a potentially multibyte string.

See also http://stackoverflow.com/questions/10360764/there-are-simple-way-to-get-a-character-from-multibyte-string-in-php View source (opens new window)

Arguments

$str (string (opens new window))
$i (integer (opens new window))

Returns

Signature

public static string getCharAt ( $str, $i )

# `getEncoding()`

Gets the current encoding of the given string.

Arguments

$string (string (opens new window))

Returns

Signature

public static string getEncoding ( $string )

# `isNotNullOrEmpty()`

Arguments

$value

Returns

Throws

Craft\Exception

Signature

public static boolean isNotNullOrEmpty ( $value )

# `isNullOrEmpty()`

Arguments

$value

Returns

Throws

Craft\Exception

Signature

public static boolean isNullOrEmpty ( $value )

# `isUTF8()`

Checks if the given string is UTF-8 encoded.

Arguments

$string – The string to check.

Returns

Signature

public static boolean isUTF8 ( $string )

# `isUUID()`

Returns is the given string matches a UUID pattern.

Arguments

$uuid

Returns

Signature

public static boolean isUUID ( $uuid )

# `lowercaseFirst()`

Lowercases the first character of a multibyte string.

Arguments

$string (string (opens new window)) – The multibyte string.

Returns

string (opens new window) – The string with the first character converted to lowercase.

Signature

public static string lowercaseFirst ( $string )

# `normalizeKeywords()`

Normalizes search keywords.

Arguments

$str (string (opens new window)) – The dirty keywords.
$ignore (array (opens new window)) – Ignore words to strip out.
$processCharMap (boolean (opens new window))

Returns

string (opens new window) – The cleansed keywords.

Signature

public static string normalizeKeywords ( $str, $ignore = [], $processCharMap = true )

# `parseMarkdown()`

Runs a string through Markdown.

Arguments

$str (string (opens new window))

Returns

Signature

public static string parseMarkdown ( $str )

# `parseMarkdownLine()`

Runs a string through Markdown, but removes any paragraph tags that get removed

Arguments

$str (string (opens new window))

Returns

Signature

public static string parseMarkdownLine ( $str )

Signature

public static string randomString ( $length = 36, $extendedChars = false )

# `splitOnWords()`

Splits a string into an array of the words in the string.

string (opens new window)[]

Arguments

$string (string (opens new window)) – The string

Returns

Signature

public static string[] splitOnWords ( $string )

# `stripHtml()`

Strips HTML tags out of a given string.

Arguments

$str (string (opens new window)) – The string.

Returns

Signature

public static string stripHtml ( $str )

# `toCamelCase()`

CamelCases a string.

See also:

Arguments

$string (string (opens new window)) – The string

Returns

Signature

public static string toCamelCase ( $string )

# `toKebabCase()`

Kebab-cases a string.

See also:

Arguments

$string (string (opens new window)) – The string
$glue (string (opens new window)) – The string used to glue the words together (default is a hyphen)
$lower (boolean (opens new window)) – Whether the string should be lowercased (default is true)
$removePunctuation (boolean (opens new window)) – Whether punctuation marks should be removed (default is true)

Returns

Signature

public static string toKebabCase ( $string, $glue = '-', $lower = true, $removePunctuation = true )

# `toLowerCase()`

Returns a multibyte aware lower-case version of a string. Note: Not using mb_strtoupper because of {@see https://bugs.php.net/bug.php?id=47742}.

Arguments

$string (string (opens new window))

Returns

Signature

public static string toLowerCase ( $string )

# `toPascalCase()`

PascalCases a string.

See also:

Arguments

$string (string (opens new window)) – The string

Returns

Signature

public static string toPascalCase ( $string )

# `toSnakeCase()`

Snake_cases a string.

See also:

Arguments

$string (string (opens new window)) – The string

Returns

Signature

public static string toSnakeCase ( $string )

# `toUpperCase()`

Returns a multibyte aware upper-case version of a string. Note: Not using mb_strtoupper because of {@see https://bugs.php.net/bug.php?id=47742}.

Arguments

$string (string (opens new window))

Returns

Signature

public static string toUpperCase ( $string )

# `uppercaseFirst()`

Uppercases the first character of a multibyte string.