Skip to content

Update randomElements to return random number of elements when no count is provided #88

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bram-pkg merged 1 commit into from
Jun 12, 2023
Merged

Update randomElements to return random number of elements when no count is provided #88

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/formatters/numbers-and-strings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,13 +92,17 @@ echo $faker->randomLetter();

## `randomElements`

Returns `$count` amount of random element from the given array, traversable, or enum. By default, the `$count` parameter is set to 1.
Returns `$count` amount of random element from the given array, traversable, or enum. By default, the `$count` parameter is set to 1, when `null` a random number of elements is returned.

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

// ['c']

echo $faker->randomElements(['a', 'b', 'c', 'd', 'e'], null);

// ['c', 'a', 'e']

echo $faker->randomElements(new \ArrayIterator(['a', 'b', 'c', 'd', 'e']));

// ['c']
Expand Down