String Class Reference

Inheritance diagram for String:


Public Member Functions
	cleanInsert ($str, $options)
	insert ($str, $data, $options=array())
Static Public Member Functions
&	getInstance ()
	tokenize ($data, $separator= ',', $leftBound= '(', $rightBound= ')')
	uuid ()

Detailed Description

Definition at line 35 of file string.php.

Member Function Documentation

String::cleanInsert	(	$	str,
		$	options
	)

Cleans up a Set::insert formated string with given $options depending on the 'clean' key in $options. The default method used is text but html is also available. The goal of this function is to replace all whitespace and uneeded markup around placeholders that did not get replaced by Set::insert.

Parameters:

	string	$str
	string	$options

Returns:: void public

Definition at line 265 of file string.php.

References a(), and am().

Referenced by insert().

& String::getInstance ( ) [static]

Gets a reference to the String object instance

Returns:: object String instance public

Definition at line 43 of file string.php.

String::insert	(	$	str,
		$	data,
		$	options = `array()`
	)

Replaces variable placeholders inside a $str with any given $data. Each key in the $data array corresponds to a variable placeholder name in $str. Example:

Sample: String::insert('My name is :name and I am :age years old.', array('name' => 'Bob', '65')); Returns: My name is Bob and I am 65 years old.

Available $options are: before: The character or string in front of the name of the variable placeholder (Defaults to ':') after: The character or string after the name of the variable placeholder (Defaults to null) escape: The character or string used to escape the before character / string (Defaults to '\') format: A regex to use for matching variable placeholders. Default is: '/(?<!\)\:s/' (Overwrites before, after, breaks escape / clean) clean: A boolean or array with instructions for String::cleanInsert

Parameters:

	string	$str A string containing variable placeholders
	string	$data A key => val array where each key stands for a placeholder variable name to be replaced with val
	string	$options An array of options, see description above