PHP's key in JavaScript

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

module.exports = functionkey (arr) {
//  discuss at: https://locutus.io/php/key/
// original by: Brett Zamir (https://brett-zamir.me)
//    input by: Riddler (https://www.frontierwebdev.com/)
// bugfixed by: Brett Zamir (https://brett-zamir.me)
//      note 1: Uses global: locutus to store the array pointer
//   example 1: var $array = {fruit1: 'apple', 'fruit2': 'orange'}
//   example 1: key($array)
//   returns 1: 'fruit1'
const $global = (typeofwindow !== 'undefined' ? window : global)
  $global.$locutus = $global.$locutus || {}
const $locutus = $global.$locutus
  $locutus.php = $locutus.php || {}
  $locutus.php.pointers = $locutus.php.pointers || []
const pointers = $locutus.php.pointers
const indexOf = function (value) {
for (let i = 0, length = this.length; i < length; i++) {
if (this[i] === value) {
return i
      }
    }
return-1
  }
if (!pointers.indexOf) {
    pointers.indexOf = indexOf
  }
if (pointers.indexOf(arr) === -1) {
    pointers.push(arr, 0)
  }
const cursor = pointers[pointers.indexOf(arr) + 1]
if (Object.prototype.toString.call(arr) !== '[object Array]') {
let ct = 0
for (const k in arr) {
if (ct === cursor) {
return k
      }
      ct++
    }
// Empty
returnfalse
  }
if (arr.length === 0) {
returnfalse
  }
return cursor
}

How to use

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

If you intend to target the browser, you can then use a module bundler such as Parcel, webpack, Browserify, or rollup.js. This can be important because Locutus allows modern JavaScript in the source files, meaning it may not work in all browsers without a build/transpile step. Locutus does transpile all functions 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.

Notes

• Uses global: locutus to store the array pointer

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.

« More PHP array functions