phpjs/_octopress/source/functions/shuffle/index.markdown

php.js offers community built php functions in javascript

---
layout: page
title: "JavaScript shuffle function"
comments: true
sharing: true
footer: true
alias:
- /functions/view/shuffle:514
- /functions/view/shuffle
- /functions/view/514
- /functions/shuffle:514
- /functions/514
---
<!-- Generated by Rakefile:build -->
A JavaScript equivalent of PHP's shuffle

{% codeblock array/shuffle.js lang:js https://raw.github.com/kvz/phpjs/master/functions/array/shuffle.js raw on github %}
function shuffle (inputArr) {
  // From: http://phpjs.org/functions
  // +   original by: Jonas Raoni Soares Silva (http://www.jsfromhell.com)
  // +    revised by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
  // +    revised by: Brett Zamir (http://brett-zamir.me)
  // +   improved by: Brett Zamir (http://brett-zamir.me)
  // %        note 1: This function deviates from PHP in returning a copy of the array instead
  // %        note 1: of acting by reference and returning true; this was necessary because
  // %        note 1: IE does not allow deleting and re-adding of properties without caching
  // %        note 1: of property position; you can set the ini of "phpjs.strictForIn" to true to
  // %        note 1: get the PHP behavior, but use this only if you are in an environment
  // %        note 1: such as Firefox extensions where for-in iteration order is fixed and true
  // %        note 1: property deletion is supported. Note that we intend to implement the PHP
  // %        note 1: behavior by default if IE ever does allow it; only gives shallow copy since
  // %        note 1: is by reference in PHP anyways
  // *     example 1: ini_set('phpjs.strictForIn', true);
  // *     example 2: var data = {5:'a', 2:'3', 3:'c', 4:5, 'q':5};
  // *     example 1: shuffle(data);
  // *     example 1: data;
  // *     returns 1: {5:'a', 4:5, 'q':5, 3:'c', 2:'3'}
  // *     example 2: ini_set('phpjs.strictForIn', true);
  // *     example 2: var data = {5:'a', 2:'3', 3:'c', 4:5, 'q':5};
  // *     example 2: shuffle(data);
  // *     example 2: data;
  // *     returns 2: {5:'a', 'q':5, 3:'c', 2:'3', 4:5}
  var valArr = [],
    k = '',
    i = 0,
    strictForIn = false,
    populateArr = [];

  for (k in inputArr) { // Get key and value arrays
    if (inputArr.hasOwnProperty(k)) {
      valArr.push(inputArr[k]);
      if (strictForIn) {
        delete inputArr[k];
      }
    }
  }
  valArr.sort(function () {
    return 0.5 - Math.random();
  });

  // BEGIN REDUNDANT
  this.php_js = this.php_js || {};
  this.php_js.ini = this.php_js.ini || {};
  // END REDUNDANT
  strictForIn = this.php_js.ini['phpjs.strictForIn'] && this.php_js.ini['phpjs.strictForIn'].local_value && this.php_js.ini['phpjs.strictForIn'].local_value !== 'off';
  populateArr = strictForIn ? inputArr : populateArr;

  for (i = 0; i < valArr.length; i++) { // Repopulate the old array
    populateArr[i] = valArr[i];
  }

  return strictForIn || populateArr;
}
{% endcodeblock %}

 - [Raw function on GitHub](https://github.com/kvz/phpjs/blob/master/functions/array/shuffle.js)

Please note that php.js uses JavaScript objects as substitutes for PHP arrays, they are 
the closest match to this hashtable-like data structure. 

Please also note that php.js offers community built functions and goes by the 
[McDonald's Theory](https://medium.com/what-i-learned-building/9216e1c9da7d). We'll put online 
functions that are far from perfect, in the hopes to spark better contributions. 
Do you have one? Then please just: 

 - [Edit on GitHub](https://github.com/kvz/phpjs/edit/master/functions/array/shuffle.js)

### Example 1
This code
{% codeblock lang:js example %}
ini_set('phpjs.strictForIn', true);
shuffle(data);
data;
{% endcodeblock %}

Should return
{% codeblock lang:js returns %}
{5:'a', 4:5, 'q':5, 3:'c', 2:'3'}
{% endcodeblock %}

### Example 2
This code
{% codeblock lang:js example %}
var data = {5:'a', 2:'3', 3:'c', 4:5, 'q':5};
ini_set('phpjs.strictForIn', true);
var data = {5:'a', 2:'3', 3:'c', 4:5, 'q':5};
shuffle(data);
data;
{% endcodeblock %}

Should return
{% codeblock lang:js returns %}
{5:'a', 'q':5, 3:'c', 2:'3', 4:5}
{% endcodeblock %}


### Other PHP functions in the array extension
{% render_partial _includes/custom/array.html %}