summaryrefslogtreecommitdiffstats
path: root/user_guide_src/source
diff options
context:
space:
mode:
authorGeorge Petculescu <gxgpet@gmail.com>2016-10-20 19:53:11 +0200
committerGeorge Petculescu <gxgpet@gmail.com>2016-10-20 19:53:11 +0200
commit11954d2521475f6964bfa9c65dcd2f3e53a65af5 (patch)
tree972c7e4f0d4ea7c29d5dd1b253be4e7fdadecef3 /user_guide_src/source
parent7de46d4d99017b42ba172cebff8998163ee6295f (diff)
moved ordinal_format() helper function from Number helper to Inflector helper
Diffstat (limited to 'user_guide_src/source')
-rw-r--r--user_guide_src/source/helpers/inflector_helper.rst17
-rw-r--r--user_guide_src/source/helpers/number_helper.rst17
2 files changed, 17 insertions, 17 deletions
diff --git a/user_guide_src/source/helpers/inflector_helper.rst b/user_guide_src/source/helpers/inflector_helper.rst
index df0c568c0..8a6ca7a92 100644
--- a/user_guide_src/source/helpers/inflector_helper.rst
+++ b/user_guide_src/source/helpers/inflector_helper.rst
@@ -93,4 +93,19 @@ The following functions are available:
Checks if the given word has a plural version. Example::
- is_countable('equipment'); // Returns FALSE \ No newline at end of file
+ is_countable('equipment'); // Returns FALSE
+
+.. php:function:: ordinal_format($number)
+
+ :param int $number: natural number to be converted
+ :returns: Ordinal numeral for given number or FALSE on failure
+ :rtype: string
+
+ Returns the ordinal numeral (0th, 1st, 2nd, 3rd etc.) for a
+ natural number. If the input is not a natural number, the
+ function will return boolean FALSE. Examples::
+
+ echo ordinal_format(1); // Returns 1st
+ echo ordinal_format(3); // Returns 3rd
+ echo ordinal_format(21); // Returns 21st
+ echo ordinal_format(102); // Returns 102nd
diff --git a/user_guide_src/source/helpers/number_helper.rst b/user_guide_src/source/helpers/number_helper.rst
index 47f616690..9d5e98cfb 100644
--- a/user_guide_src/source/helpers/number_helper.rst
+++ b/user_guide_src/source/helpers/number_helper.rst
@@ -49,19 +49,4 @@ The following functions are available:
echo byte_format(45678, 2); // Returns 44.61 KB
.. note:: The text generated by this function is found in the following
- language file: *language/<your_lang>/number_lang.php*
-
-.. php:function:: ordinal_format($number)
-
- :param int $number: natural number to be converted
- :returns: Ordinal numeral for given number or FALSE on failure
- :rtype: string
-
- Returns the ordinal numeral (0th, 1st, 2nd, 3rd etc.) for a
- natural number. If the input is not a natural number, the
- function will return boolean FALSE. Examples::
-
- echo ordinal_format(1); // Returns 1st
- echo ordinal_format(3); // Returns 3rd
- echo ordinal_format(21); // Returns 21st
- echo ordinal_format(102); // Returns 102nd
+ language file: *language/<your_lang>/number_lang.php* \ No newline at end of file