String helper

---

Description

The string helper contains a collection of string manipulation methods.

Methods

random([string $pool = String::ALNUM [, int $length = 32]])

The random method returns a random string of the selected type and length. The available constants are 'ALNUM', 'ALPHA', 'HEXDEC', 'NUMERIC' and 'SYMBOLS'. You can also combine pools or pass your own pool of characters.

$str = String::random(String::ALNUM);

$str = String::random(String::ALPHA);

$str = String::random(String::NUMERIC);

$str = String::random(String::ALNUM . String::SYMBOLS);

$str = String::random(String::ALNUM . 'æøåÆØÅ', 64);

nl2br(string $string)

The nl2br method converts newlines to <br>.

$str = String::nl2br($_POST['input']);

br2nl(string $string)

The br2nl method converts <br /> and <br> to newlines.

$str = String::br2nl($input);

limitChars(string $string [, int $characters = 100 [, string $sufix = '...']])

The limitChars method will limit the number of characters in a string.

$str = String::limitChars($input, 300);

limitWords(string $string [, int $words = 100 [, string $sufix = '...']])

The limitWords method will limit the number of words in a string.

$str = String::limitWords($input, 300);

increment(string $string [, int $start = 1 [, string $separator = '_']])

The increment method append an incremental numeric sufix to a string.

$str = String::increment('banana'); // Will return "banana_1"
$str = String::increment('banana_1'); // Will return "banana_2"

alternator(array $strings)

The alternator method will return a closure that alternates between the chosen strings.

$alt = String::alternator(array('foo', 'bar'));

echo $alt(); // foo
echo $alt(); // bar
echo $alt(); // foo

ascii(string $string)

The ascii method returns string where all non-ASCII characters have been stripped.

// $str will be set to "Hello, world! It Works!"

$str = String::ascii('Hello, world! ÆØÅ It Works!');

slug(string $string)

The slug method returns a URL friendly string.

$str = String::slug('Hello World!'); // $str will be set to "hello-world"

autolink(string $string [, array $attributes = array()])

The autolink method returns a string where all URLs are converted into clickable links.

$str = String::autolink($text);

mask(string $string [, int $visible = 3 [, string $mask = '*']])

The mask method will return a masked string where n characters are visible while the rest will be masked.

$str = String::mask('password'); // $str will be set to "*****ord"

camel2underscored(string)

The camel2underscored method will convert camel case to underscored.

$str = String::camel2underscored('HelloWorld'); // $str will be set to "hello_world"

underscored2camel(string [, boolean $upper = false])

The underscored2camel method will convert underscored to camel case.

$str = String::camel2underscored('hello_world'); // $str will be set to "helloWorld"
$str = String::camel2underscored('hello_world', true); // $str will be set to "HelloWorld"