Skip to content

Commit 0adcedc

Browse files
Added documentation for spellOrdinal in Number Facade (#10338)
* Added documentation for `spellOrdinal` in Number Facade * Update helpers.md --------- Co-authored-by: Taylor Otwell <[email protected]>
1 parent f25d00a commit 0adcedc

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

helpers.md

+22
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@ Laravel includes a variety of global "helper" PHP functions. Many of these funct
108108
[Number::pairs](#method-number-pairs)
109109
[Number::percentage](#method-number-percentage)
110110
[Number::spell](#method-number-spell)
111+
[Number::spellOrdinal](#method-number-spell-ordinal)
111112
[Number::trim](#method-number-trim)
112113
[Number::useLocale](#method-number-use-locale)
113114
[Number::withLocale](#method-number-with-locale)
@@ -1649,6 +1650,27 @@ $number = Number::spell(10, until: 10);
16491650
// 10
16501651
```
16511652

1653+
<a name="method-number-spell-ordinal"></a>
1654+
#### `Number::spellOrdinal()` {.collection-method}
1655+
1656+
The `Number::spellOrdinal` method returns the number's ordinal representation as a string of words:
1657+
1658+
```php
1659+
use Illuminate\Support\Number;
1660+
1661+
$number = Number::spellOrdinal(1);
1662+
1663+
// first
1664+
1665+
$number = Number::spellOrdinal(2);
1666+
1667+
// second
1668+
1669+
$number = Number::spellOrdinal(21);
1670+
1671+
// twenty-first
1672+
```
1673+
16521674
<a name="method-number-trim"></a>
16531675
#### `Number::trim()` {.collection-method}
16541676

0 commit comments

Comments
 (0)