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

php.js offers community built php functions in javascript

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

{% codeblock array/array_search.js lang:js https://raw.github.com/kvz/phpjs/master/functions/array/array_search.js raw on github %}
function array_search (needle, haystack, argStrict) {
  // From: http://phpjs.org/functions
  // +   original by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
  // +      input by: Brett Zamir (http://brett-zamir.me)
  // +   bugfixed by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
  // -    depends on: array
  // *          test: skip
  // *     example 1: array_search('zonneveld', {firstname: 'kevin', middle: 'van', surname: 'zonneveld'});
  // *     returns 1: 'surname'
  // *     example 2: ini_set('phpjs.return_phpjs_arrays', 'on');
  // *     example 2: var ordered_arr = array({3:'value'}, {2:'value'}, {'a':'value'}, {'b':'value'});
  // *     example 2: var key = array_search(/val/g, ordered_arr); // or var key = ordered_arr.search(/val/g);
  // *     returns 2: '3'

  var strict = !!argStrict,
    key = '';

  if (haystack && typeof haystack === 'object' && haystack.change_key_case) { // Duck-type check for our own array()-created PHPJS_Array
    return haystack.search(needle, argStrict);
  }
  if (typeof needle === 'object' && needle.exec) { // Duck-type for RegExp
    if (!strict) { // Let's consider case sensitive searches as strict
      var flags = 'i' + (needle.global ? 'g' : '') +
            (needle.multiline ? 'm' : '') +
            (needle.sticky ? 'y' : ''); // sticky is FF only
      needle = new RegExp(needle.source, flags);
    }
    for (key in haystack) {
      if (needle.test(haystack[key])) {
        return key;
      }
    }
    return false;
  }

  for (key in haystack) {
    if ((strict && haystack[key] === needle) || (!strict && haystack[key] == needle)) {
      return key;
    }
  }

  return false;
}
{% endcodeblock %}

 - [Raw function on GitHub](https://github.com/kvz/phpjs/blob/master/functions/array/array_search.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/array_search.js)

### Example 1
This code
{% codeblock lang:js example %}
array_search('zonneveld', {firstname: 'kevin', middle: 'van', surname: 'zonneveld'});
{% endcodeblock %}

Should return
{% codeblock lang:js returns %}
'surname'
{% endcodeblock %}

### Example 2
This code
{% codeblock lang:js example %}
ini_set('phpjs.return_phpjs_arrays', 'on');
var ordered_arr = array({3:'value'}, {2:'value'}, {'a':'value'}, {'b':'value'});
var key = array_search(/val/g, ordered_arr); // or var key = ordered_arr.search(/val/g);
{% endcodeblock %}

Should return
{% codeblock lang:js returns %}
'3'
{% endcodeblock %}


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