Add counted() inflector

Author: MGatner

system/Helpers/inflector_helper.php

@@ -165,6 +165,29 @@ function plural(string $string): string
 
 //--------------------------------------------------------------------
 
+if (! function_exists('counted'))
+{
+	/**
+	 * Counted
+	 *
+	 * Takes a number and a word to return the plural or not
+	 * E.g. 0 cats, 1 cat, 2 cats, ...
+	 *
+	 * @param  int    $count  Number of items
+	 * @param  string $string Input string
+	 * @return string
+	 */
+	function counted(int $count, string $string): string
+	{
+		$result  = "{$count} ";
+		$result .= $count === 1 ? singular($string) : plural($string);
+
+		return $result;
+	}
+}
+
+//--------------------------------------------------------------------
+
 if (! function_exists('camelize'))
 {
 	/**

tests/system/Helpers/InflectorHelperTest.php

@@ -92,6 +92,29 @@ public function testPlural()
 
 	//--------------------------------------------------------------------
 
+	public function testCounted()
+	{
+		$triplets = [
+			[3, 'cat', '3 cats'],
+			[1, 'cat', '1 cat'],
+			[0, 'cat', '0 cats'],
+			[3, 'cats', '3 cats'],
+			[1, 'cats', '1 cat'],
+			[0, 'cats', '0 cats'],
+			[3, 'fish', '3 fish'],
+			[1, 'fish', '1 fish'],
+			[0, 'fish', '0 fish'],
+		];
+
+		foreach ($triplets as $triplet)
+		{
+			$result = counted($triplet[0], $triplet[1]);
+			$this->assertEquals($triplet[2], $result);
+		}
+	}
+
+	//--------------------------------------------------------------------
+
 	public function testCamelize()
 	{
 		$strings = [

user_guide_src/source/helpers/inflector_helper.rst

@@ -44,6 +44,17 @@ The following functions are available:
 
 		echo plural('dog'); // Prints 'dogs'
 
+.. php:function:: counted($count, $string)
+
+	:param	int 	$count:  Number of items
+	:param	string	$string: Input string
+	:returns:	A singular or plural phrase
+	:rtype:	string
+
+	Changes a word and its count to a phrase. Example::
+
+		echo counted(3, 'dog'); // Prints '3 dogs'
+
 .. php:function:: camelize($string)
 
 	:param	string	$string: Input string