refactor error enhandling of path_helper

zhanghongyi · zhanghongyi · commit ee63140e0e72 · 2015-12-08T08:28:39.000-08:00
Signed-off-by: Hongyi Zhang &lt;hongyi73.zhang@gmail.com&gt;
diff --git a/system/helpers/path_helper.php b/system/helpers/path_helper.php
@@ -57,13 +57,14 @@
 	 * @param	string
 	 * @param	bool	checks to see if the path exists
 	 * @return	string
+	 * @throws	InvalidArgumentException
 	 */
 	function set_realpath($path, $check_existance = FALSE)
 	{
 		// Security check to make sure the path is NOT a URL. No remote file inclusion!
 		if (preg_match('#^(http:\/\/|https:\/\/|www\.|ftp)#i', $path) OR filter_var($path, FILTER_VALIDATE_IP) === $path )
 		{
-			show_error('The path you submitted must be a local server path, not a URL');
+			throw new InvalidArgumentException('The path you submitted must be a local server path, not a URL');
 		}
 
 		// Resolve the path
@@ -73,7 +74,7 @@ function set_realpath($path, $check_existance = FALSE)
 		}
 		elseif ($check_existance && ! is_dir($path) && ! is_file($path))
 		{
-			show_error('Not a valid path: '.$path);
+			throw new InvalidArgumentException('Not a valid path: '.$path);
 		}
 
 		// Add a trailing slash, if this is a directory
diff --git a/tests/codeigniter/helpers/path_helper_test.php b/tests/codeigniter/helpers/path_helper_test.php
@@ -21,7 +21,7 @@ public function test_set_realpath_nonexistent_directory()
 	public function test_set_realpath_error_trigger()
 	{
 		$this->setExpectedException(
-				'RuntimeException', 'CI Error: Not a valid path: /path/to/nowhere'
+				'InvalidArgumentException', 'Not a valid path: /path/to/nowhere'
 		);
 
 		set_realpath('/path/to/nowhere', TRUE);
diff --git a/user_guide_src/source/helpers/path_helper.rst b/user_guide_src/source/helpers/path_helper.rst
@@ -31,6 +31,7 @@ The following functions are available:
 	:param	bool	$check_existance: Whether to check if the path actually exists
 	:returns:	An absolute path
 	:rtype:	string
+	:throws: InvalidArgumentException
 
 	This function will return a server path without symbolic links or
 	relative directory structures. An optional second argument will
@@ -50,4 +51,4 @@ The following functions are available:
 
 		$non_existent_directory = '/path/to/nowhere';
 		echo set_realpath($non_existent_directory, TRUE);	// Shows an error, as the path cannot be resolved
-		echo set_realpath($non_existent_directory, FALSE);	// Prints '/path/to/nowhere'
+		echo set_realpath($non_existent_directory, FALSE);	// Prints '/path/to/nowhere'

Original file line number	Diff line number	Diff line change
`@@ -57,13 +57,14 @@`
`57`	`57`	`* @param string`
`58`	`58`	`* @param bool checks to see if the path exists`
`59`	`59`	`* @return string`
	`60`	`+ * @throws InvalidArgumentException`
`60`	`61`	`*/`
`61`	`62`	`function set_realpath($path, $check_existance = FALSE)`
`62`	`63`	`{`
`63`	`64`	`// Security check to make sure the path is NOT a URL. No remote file inclusion!`
`64`	`65`	`if (preg_match('#^(http:\/\/\|https:\/\/\|www\.\|ftp)#i', $path) OR filter_var($path, FILTER_VALIDATE_IP) === $path )`
`65`	`66`	`{`
`66`		`- show_error('The path you submitted must be a local server path, not a URL');`
	`67`	`+ throw new InvalidArgumentException('The path you submitted must be a local server path, not a URL');`
`67`	`68`	`}`
`68`	`69`
`69`	`70`	`// Resolve the path`
`@@ -73,7 +74,7 @@ function set_realpath($path, $check_existance = FALSE)`
`73`	`74`	`}`
`74`	`75`	`elseif ($check_existance && ! is_dir($path) && ! is_file($path))`
`75`	`76`	`{`
`76`		`- show_error('Not a valid path: '.$path);`
	`77`	`+ throw new InvalidArgumentException('Not a valid path: '.$path);`
`77`	`78`	`}`
`78`	`79`
`79`	`80`	`// Add a trailing slash, if this is a directory`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ public function test_set_realpath_nonexistent_directory()`
`21`	`21`	`public function test_set_realpath_error_trigger()`
`22`	`22`	`{`
`23`	`23`	`$this->setExpectedException(`
`24`		`- 'RuntimeException', 'CI Error: Not a valid path: /path/to/nowhere'`
	`24`	`+ 'InvalidArgumentException', 'Not a valid path: /path/to/nowhere'`
`25`	`25`	`);`
`26`	`26`
`27`	`27`	`set_realpath('/path/to/nowhere', TRUE);`