Skip to content

Commit 029142a

Browse files
authored
Enhancement: Document support for Traversables and Enums (#85)
1 parent bb3b4d2 commit 029142a

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

docs/formatters/numbers-and-strings.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,25 +92,59 @@ echo $faker->randomLetter();
9292

9393
## `randomElements`
9494

95-
Returns `$count` amount of random element from the given array. By default, the `$count` parameter is set to 1.
95+
Returns `$count` amount of random element from the given array, traversable, or enum. By default, the `$count` parameter is set to 1.
9696

9797
```php
9898
echo $faker->randomElements(['a', 'b', 'c', 'd', 'e']);
9999

100100
// ['c']
101101

102+
echo $faker->randomElements(new \ArrayIterator(['a', 'b', 'c', 'd', 'e']));
103+
104+
// ['c']
105+
106+
enum Bar
107+
{
108+
case A = 'a';
109+
case B = 'b';
110+
case C = 'c';
111+
case D = 'd';
112+
case E = 'e';
113+
}
114+
115+
echo $faker->randomElements(Bar::class);
116+
117+
// ['c']
118+
102119
echo $faker->randomElements(['a', 'b', 'c', 'd', 'e'], 3);
103120

104121
// ['a', 'd', 'e']
105122
```
106123

107124
## `randomElement`
108125

109-
Returns a random element from the given array.
126+
Returns a random element from the given array, traversable, or enum.
110127

111128
```php
112129
echo $faker->randomElement(['a', 'b', 'c', 'd', 'e']);
113130

131+
// 'c'
132+
133+
echo $faker->randomElement(new \ArrayIterator(['a', 'b', 'c', 'd', 'e']));
134+
135+
// 'c'
136+
137+
enum Bar
138+
{
139+
case A = 'a';
140+
case B = 'b';
141+
case C = 'c';
142+
case D = 'd';
143+
case E = 'e';
144+
}
145+
146+
echo $faker->randomElement(Bar::class);
147+
114148
// 'c'
115149
```
116150

0 commit comments

Comments
 (0)