PHP's array_rand in JavaScript

Here’s what our current JavaScript equivalent to PHP's array_rand looks like.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
module.exports = function array_rand (array, num) { // eslint-disable-line camelcase
// discuss at: http://locutus.io/php/array_rand/
// original by: Waldo Malqui Silva (http://waldo.malqui.info)
// reimplemented by: Rafał Kukawski
// example 1: array_rand( ['Kevin'], 1 )
// returns 1: '0'

// By using Object.keys we support both, arrays and objects
// which phpjs wants to support
var keys = Object.keys(array)

if (typeof num === 'undefined' || num === null) {
num = 1
} else {
num = +num
}

if (isNaN(num) || num < 1 || num > keys.length) {
return null
}

// shuffle the array of keys
for (var i = keys.length - 1; i > 0; i--) {
var j = Math.floor(Math.random() * (i + 1)) // 0 ≤ j ≤ i

var tmp = keys[j]
keys[j] = keys[i]
keys[i] = tmp
}

return num === 1 ? keys[0] : keys.slice(0, num)
}
[ View on GitHub | Edit on GitHub | Source on GitHub ]

How to use

You you can install via npm install locutus and require it via require('locutus/php/array/array_rand'). You could also require the array module in full so that you could access array.array_rand instead.

If you intend to target the browser, you can then use a module bundler such as Browserify, webpack or rollup.js.

ES5/ES6

This function targets ES5, but as of Locutus 2.0.2 we also support ES6 functions. Locutus transpiles to ES5 before publishing to npm.

PHP arrays and JavaScript

Please note that Locutus uses JavaScript objects as substitutes for PHP arrays, they are the closest we can get to this hashtable-like data structure without rolling our own. While many JavaScript implementations preserve the order of object properties, the ECMAScript Language Specification explicitly states that:

The mechanics and order of enumerating the properties is not specified.

So don't use this for anything serious if you rely on the order to be consistent accross platforms.

A community effort

Not unlike Wikipedia, Locutus is an ongoing community effort. Our philosophy follows The McDonald’s Theory. This means that we don't consider it to be a bad thing that many of our functions are first iterations, which may still have their fair share of issues. We hope that these flaws will inspire others to come up with better ideas.

This way of working also means that we don't offer any production guarantees, and recommend to use Locutus inspiration and learning purposes only.

Examples

Please note that these examples are distilled from test cases that automatically verify our functions still work correctly. This could explain some quirky ones.

#codeexpected result
1array_rand( ['Kevin'], 1 )'0'

« More PHP array functions