Merge pull request laravel#811 from xsbeats/feature/str_limit_exact

taylorotwell · taylorotwell · commit 8f8fa0970848 · 2012-09-01T16:51:39.000-07:00
Feature: Str::limit_exact    limits a string including its custom ending to a specified length
diff --git a/laravel/documentation/strings.md b/laravel/documentation/strings.md
@@ -25,6 +25,7 @@ The **Str** class also provides three convenient methods for manipulating string
 #### Limiting the number of characters in a string:
 
 	echo Str::limit($string, 10);
+	echo Str::limit_exact($string, 10);
 
 #### Limiting the number of words in a string:
 
diff --git a/laravel/str.php b/laravel/str.php
@@ -130,6 +130,31 @@ public static function limit($value, $limit = 100, $end = '...')
 		return substr($value, 0, $limit).$end;
 	}
 
+	/**
+	 * Limit the number of chracters in a string including custom ending
+	 * 
+	 * <code>
+	 *		// Returns "Taylor..."
+	 *		echo Str::limit_exact('Taylor Otwell', 9);
+	 *
+	 *		// Limit the number of characters and append a custom ending
+	 *		echo Str::limit_exact('Taylor Otwell', 9, '---');
+	 * </code>
+	 * 
+	 * @param  string  $value
+	 * @param  int     $limit
+	 * @param  string  $end
+	 * @return string
+	 */
+	public static function limit_exact($value, $limit = 100, $end = '...')
+	{
+		if (static::length($value) <= $limit) return $value;
+
+		$limit -= static::length($end);
+
+		return static::limit($value, $limit, $end);
+	}
+
 	/**
 	 * Limit the number of words in a string.
 	 *
