Update String helper docs

1 files changed, 96 insertions, 108 deletions

diff --git a/user_guide_src/source/helpers/string_helper.rst b/user_guide_src/source/helpers/string_helper.rst
index b6417c2a6..1ca654ea6 100644
--- a/user_guide_src/source/helpers/string_helper.rst
+++ b/user_guide_src/source/helpers/string_helper.rst
@@ -5,7 +5,12 @@ String Helper
 The String Helper file contains functions that assist in working with
 strings.
 
-.. contents:: Page Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
 
 Loading this Helper
 ===================
@@ -14,124 +19,115 @@ This helper is loaded using the following code::
 
 	$this->load->helper('string');
 
+Available Functions
+===================
+
 The following functions are available:
 
-random_string()
-===============
 
-.. function:: random_string($type = 'alnum', $len = 8)
+.. function:: random_string([$type = 'alnum'[, $len = 8]])
 
 	:param	string	$type: Randomization type
 	:param	int	$len: Output string length
 	:returns:	string
 
-Generates a random string based on the type and length you specify.
-Useful for creating passwords or generating random hashes.
+	Generates a random string based on the type and length you specify.
+	Useful for creating passwords or generating random hashes.
 
-The first parameter specifies the type of string, the second parameter
-specifies the length. The following choices are available:
+	The first parameter specifies the type of string, the second parameter
+	specifies the length. The following choices are available:
 
--  **alpha**: A string with lower and uppercase letters only.
--  **alnum**: Alpha-numeric string with lower and uppercase characters.
--  **basic**: A random number based on ``mt_rand()``.
--  **numeric**: Numeric string.
--  **nozero**: Numeric string with no zeros.
--  **md5**: An encrypted random number based on ``md5()`` (fixed length of 32).
--  **sha1**: An encrypted random number based on ``sha1()`` (fixed length of 40).
+	-  **alpha**: A string with lower and uppercase letters only.
+	-  **alnum**: Alpha-numeric string with lower and uppercase characters.
+	-  **basic**: A random number based on ``mt_rand()``.
+	-  **numeric**: Numeric string.
+	-  **nozero**: Numeric string with no zeros.
+	-  **md5**: An encrypted random number based on ``md5()`` (fixed length of 32).
+	-  **sha1**: An encrypted random number based on ``sha1()`` (fixed length of 40).
 
-Usage example::
+	Usage example::
 
-	echo random_string('alnum', 16);
+		echo random_string('alnum', 16);
 
-.. note:: Usage of the *unique* and *encrypt* types is DEPRECATED. They
-	are just aliases for *md5* and *sha1* respectively.
+	.. note:: Usage of the *unique* and *encrypt* types is DEPRECATED. They
+		are just aliases for *md5* and *sha1* respectively.
 
-increment_string()
-==================
 
-.. function:: increment_string($str, $separator = '_', $first = 1)
+.. function:: increment_string($str[, $separator = '_'[, $first = 1]])
 
 	:param	string	$str: Input string
 	:param	string	$separator: Separator to append a duplicate number with
 	:param	int	$first: Starting number
 	:returns:	string
 
-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.
+	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::
+	Usage example::
 
-	echo increment_string('file', '_'); // "file_1"
-	echo increment_string('file', '-', 2); // "file-2"
-	echo increment_string('file_4'); // "file_5"
+		echo increment_string('file', '_'); // "file_1"
+		echo increment_string('file', '-', 2); // "file-2"
+		echo increment_string('file_4'); // "file_5"
 
-alternator()
-============
 
 .. function:: alternator($args)
 
 	:param	mixed	$args: A variable number of arguments
 	:returns:	mixed
 
-Allows two or more items to be alternated between, when cycling through
-a loop. Example::
+	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');
-	}
+		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.
+	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');
-	}
+		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.
+	.. note:: To use multiple separate calls to this function simply call the
+		function with no arguments to re-initialize.
 
-repeater()
-==========
 
-.. function:: repeater($data, $num = 1)
+.. function:: repeater($data[, $num = 1])
 
 	:param	string	$data: Input
 	:param	int	$num: Number of times to repeat
 	:returns:	string
 
-Generates repeating copies of the data you submit. Example::
+	Generates repeating copies of the data you submit. Example::
 
-	$string = "\n";
-	echo repeater($string, 30);
+		$string = "\n";
+		echo repeater($string, 30);
 
-The above would generate 30 newlines.
+	The above would generate 30 newlines.
 
-.. note:: This function is DEPRECATED. Use the native ``str_repeat()``
-	instead.
+	.. note:: This function is DEPRECATED. Use the native ``str_repeat()``
+		instead.
 
-reduce_double_slashes()
-=======================
 
 .. function:: reduce_double_slashes($str)
 
 	:param	string	$str: Input string
 	:returns:	string
 
-Converts double slashes in a string to a single slash, except those
-found in URL protocol prefixes (e.g. http://).
+	Converts double slashes in a string to a single slash, except those
+	found in URL protocol prefixes (e.g. http://).
 
-Example::
+	Example::
 
-	$string = "http://example.com//index.php";
-	echo reduce_double_slashes($string); // results in "http://example.com/index.php"
+		$string = "http://example.com//index.php";
+		echo reduce_double_slashes($string); // results in "http://example.com/index.php"
 
-strip_slashes()
-===============
 
 .. function:: strip_slashes($data)
 
@@ -140,88 +136,80 @@ strip_slashes()
 
 Removes any slashes from an array of strings.
 
-Example::
+	Example::
 
-	$str = array(
-		'question'  => 'Is your name O\'reilly?',
-		'answer' => 'No, my name is O\'connor.'
-	);
+		$str = array(
+			'question'  => 'Is your name O\'reilly?',
+			'answer' => 'No, my name is O\'connor.'
+		);
 
-	$str = strip_slashes($str);
+		$str = strip_slashes($str);
 
-The above will return the following array::
+	The above will return the following array::
 
-	array(
-		'question'  => "Is your name O'reilly?",
-		'answer' => "No, my name is O'connor."
-	);
+		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 ``stripslashes()``.
+	.. note:: For historical reasons, this function will also accept
+		and handle string inputs. This however makes it just an
+		alias for ``stripslashes()``.
 
-trim_slashes()
-==============
 
 .. function:: trim_slashes($str)
 
 	:param	string	$str: Input string
 	:returns:	string
 
-Removes any leading/trailing slashes from a string. Example::
+	Removes any leading/trailing slashes from a string. Example::
 
-	$string = "/this/that/theother/";
-	echo trim_slashes($string); // results in this/that/theother
+		$string = "/this/that/theother/";
+		echo trim_slashes($string); // results in this/that/theother
 
-.. note:: This function is DEPRECATED. Use the native ``trim()`` instead:
-	|
-	| trim($str, '/');
+	.. note:: This function is DEPRECATED. Use the native ``trim()`` instead:
+		|
+		| trim($str, '/');
 
-reduce_multiples()
-==================
 
-.. function:: reduce_multiples($str, $character = '', $trim = FALSE)
+.. function:: reduce_multiples($str[, $character = ''[, $trim = FALSE]])
 
 	:param	string	$str: Text to search in
 	:param	string	$character: Character to reduce
 	:param	bool	$trim: Whether to also trim the specified character
 	:returns:	string
 
-Reduces multiple instances of a particular character occuring directly
-after each other. Example::
+	Reduces multiple instances of a particular character occuring directly
+	after each other. Example::
 
-	$string = "Fred, Bill,, Joe, Jimmy";
-	$string = reduce_multiples($string,","); //results in "Fred, Bill, Joe, Jimmy"
+		$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 occurences of the
-character at the beginning and the end of the string. Example::
+	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"
+		$string = ",Fred, Bill,, Joe, Jimmy,";
+		$string = reduce_multiples($string, ", ", TRUE); //results in "Fred, Bill, Joe, Jimmy"
 
-quotes_to_entities()
-====================
 
 .. function:: quotes_to_entities($str)
 
 	:param	string	$str: Input string
 	:returns:	string
 
-Converts single and double quotes in a string to the corresponding HTML
-entities. Example::
+	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&#39;s &quot;dinner&quot;"
+		$string = "Joe's \"dinner\"";
+		$string = quotes_to_entities($string); //results in "Joe&#39;s &quot;dinner&quot;"
 
-strip_quotes()
-==============
 
 .. function:: strip_quotes($str)
 
 	:param	string	$str: Input string
 	:returns:	string
 
-Removes single and double quotes from a string. Example::
+	Removes single and double quotes from a string. Example::
 
-	$string = "Joe's \"dinner\"";
-	$string = strip_quotes($string); //results in "Joes dinner"
\ No newline at end of file
+		$string = "Joe's \"dinner\"";
+		$string = strip_quotes($string); //results in "Joes dinner"
\ No newline at end of file