diff options
| author | Andrey Andreev <narf@bofh.bg> | 2012-11-09 09:27:43 +0100 |
|---|---|---|
| committer | Andrey Andreev <narf@bofh.bg> | 2012-11-09 09:27:43 +0100 |
| commit | 08f0f8b751c0e956e12fade9f6eea2bd581042ac (patch) | |
| tree | 2ed7577bcf85fa1d2ae5b546bb2b544ceae5f953 /system/helpers | |
| parent | 442682e488181a9e9139f02bb657e501eb78573d (diff) | |
Polish docs for URL and XML helpers and deprecate obsolete options for String helper random_string() and URL helper url_title()
Diffstat (limited to 'system/helpers')
| -rw-r--r-- | system/helpers/url_helper.php | 17 |
1 files changed, 10 insertions, 7 deletions
diff --git a/system/helpers/url_helper.php b/system/helpers/url_helper.php index 8e9cb7b03..0aa358a0b 100644 --- a/system/helpers/url_helper.php +++ b/system/helpers/url_helper.php @@ -474,9 +474,11 @@ if ( ! function_exists('url_title')) * human-friendly URL string with a "separator" string * as the word separator. * - * @param string the string - * @param string the separator - * @param bool + * @todo Remove old 'dash' and 'underscore' usage in 3.1+. + * @param string $str Input string + * @param string $separator Word separator + * (usually '-' or '_') + * @param bool $lowercase Wether to transform the output string to lowercase * @return string */ function url_title($str, $separator = '-', $lowercase = FALSE) @@ -525,10 +527,11 @@ if ( ! function_exists('redirect')) * For very fine grained control over headers, you could use the Output * Library's set_header() function. * - * @param string the URL - * @param string the method: location or refresh - * @param int - * @return string + * @param string $uri URL + * @param string $method Redirect method + * 'auto', 'location' or 'refresh' + * @param int $code HTTP Response status code + * @return void */ function redirect($uri = '', $method = 'auto', $code = NULL) { |