add php-doc for ellipsis

This commit is contained in:
Jörn Friedrich Dreyer 2012-11-12 14:04:23 +01:00
parent 28671d92c0
commit 0ce5e9257e
1 changed files with 8 additions and 2 deletions

View File

@ -712,8 +712,14 @@ class OC_Helper {
return false;
}
/**
* Shortens str to maxlen by replacing characters in the middle with '...', eg.
* ellipsis('a very long string with lots of useless info to make a better example', 14) becomes 'a very ...example'
* @param string $str the string
* @param string $maxlen the maximum length of the result
* @return string with at most maxlen characters
*/
public static function ellipsis($str, $maxlen) {
if (strlen($str) > $maxlen) {
$characters = floor($maxlen / 2);
@ -721,5 +727,5 @@ class OC_Helper {
}
return $str;
}
}