Class DataStructureString

String Data Structure helper

Provides utility methods to assist in manipulating strings.

Package: blesta\helpers\data\structure\string
Copyright: Copyright (c) 2010, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at helpers/data_structure/string/data_structure_string.php

Methods summary

`public string`	# `random( integer $length = 8, string $pool = null, array $options = array() )` Generates a random string from a list of characters Generates a random string from a list of characters Parameters `$length` `integer` $length The length of the random string `$pool` `string` $pool The pool of characters to include in the random string, defaults to alpha numeric characters. Can be configured further in $options['types'] `$options` `array` $options An array of options including: - types A numerically indexed-array of character-types that may be used to generate the random string (i.e. "alpha", "alpha_lower", "alpha_upper", and/or "numeric") (optional) Returns `string` A randomly generated word with the given length
`public`	# `truncate( string $input, array $options = array() )` Truncates the string using the given options Truncates the string using the given options Parameters `$input` `string` $input The input string to truncate `$options` `array` $options A list of options including any of the following: - length The number of characters to truncate to - NOT multi-byte-safe (optional, default null) - word_length The number of words to truncate to, broken at spaces (optional, default null) - line_break True to truncate at the first new line, or false to allow new line breaks (optional, default true)

Packages

Classes

Class DataStructureString

Methods summary

Parameters

Returns

Parameters

Magic methods summary