The String Helper file contains functions that assist in working with strings. Important Please note that these functions are NOT intended, nor suitable to be used for any kind of security-related logic. Available Functions¶The following functions are available: random_string ([$type = 'alnum'[, $len = 8]])¶
Generates a random string based on the type and length you specify. The first parameter specifies the type of string, the second parameter specifies the length. The following choices are available:
Usage example: echo random_string('alnum', 16); Note Usage of this function is NOT suitable for password generation or other security-sensitive purposes. Please use random_bytes() instead. Note Usage of the unique and encrypt types is DEPRECATED. They are just aliases for md5 and sha1 respectively. increment_string ($str[, $separator = '_'[, $first = 1]])¶
Increments a string by appending a number to it or increasing the number. Useful for creating “copies” or a file or duplicating database content which has unique titles or slugs. Usage example: echo increment_string('file', '_'); // "file_1" echo increment_string('file', '-', 2); // "file-2" echo increment_string('file_4'); // "file_5" alternator ($args)¶
Allows two or more items to be alternated between, when cycling through a loop. Example: for ($i = 0; $i < 10; $i++) { echo alternator('string one', 'string two'); } You can add as many parameters as you want, and with each iteration of your loop the next item will be returned. for ($i = 0; $i < 10; $i++) { echo alternator('one', 'two', 'three', 'four', 'five'); } Note To use multiple separate calls to this function simply call the function with no arguments to re-initialize. repeater ($data[, $num = 1])¶
Generates repeating copies of the data you submit. Example: $string = "\n"; echo repeater($string, 30); The above would generate 30 newlines. Note This function is DEPRECATED. Use the native reduce_double_slashes ($str)¶
Converts double slashes in a string to a single slash, except those found in URL protocol prefixes (e.g. http://). Example: $string = "http://example.com//index.php"; echo reduce_double_slashes($string); // results in "http://example.com/index.php" strip_slashes ($data)¶
Removes any slashes from an array of strings. Example: $str = array( 'question' => 'Is your name O\'reilly?', 'answer' => 'No, my name is O\'connor.' ); $str = strip_slashes($str); The above will return the following array: array( 'question' => "Is your name O'reilly?", 'answer' => "No, my name is O'connor." ); Note For historical reasons, this function will also accept and handle string inputs. This however makes it just an alias for trim_slashes ($str)¶
Removes any leading/trailing slashes from a string. Example: $string = "/this/that/theother/"; echo trim_slashes($string); // results in this/that/theother Note This function is DEPRECATED. Use the native reduce_multiples ($str[, $character = ''[, $trim = FALSE]])¶
Reduces multiple instances of a particular character occurring directly after each other. Example: $string = "Fred, Bill,, Joe, Jimmy"; $string = reduce_multiples($string,","); //results in "Fred, Bill, Joe, Jimmy" If the third parameter is set to TRUE it will remove occurrences of the character at the beginning and the end of the string. Example: $string = ",Fred, Bill,, Joe, Jimmy,"; $string = reduce_multiples($string, ", ", TRUE); //results in "Fred, Bill, Joe, Jimmy" quotes_to_entities ($str)¶
Converts single and double quotes in a string to the corresponding HTML entities. Example: $string = "Joe's \"dinner\""; $string = quotes_to_entities($string); //results in "Joe's "dinner"" strip_quotes ($str)¶
Removes single and double quotes from a string. Example: $string = "Joe's \"dinner\""; $string = strip_quotes($string); //results in "Joes dinner" |