locutus
Version:
Locutus other languages' standard libraries to JavaScript for fun and educational purposes
119 lines (118 loc) • 4.83 kB
JavaScript
import { ensurePhpRuntimeState } from "../_helpers/_phpRuntimeState.js";
import { i18n_loc_get_default as i18nlgd } from "../i18n/i18n_loc_get_default.js";
import { strnatcmp } from "../strings/strnatcmp.js";
export function ksort(inputArr, sortFlags) {
// discuss at: https://locutus.io/php/ksort/
// original by: GeekFG (https://geekfg.blogspot.com)
// improved by: Kevin van Zonneveld (https://kvz.io)
// improved by: Brett Zamir (https://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 "locutus.sortByReference" 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
// note 1: Since JS objects' keys are always strings, and (the
// note 1: default) SORT_REGULAR flag distinguishes by key type,
// note 1: if the content is a numeric string, we treat the
// note 1: "original type" as numeric.
// example 1: var $data = {d: 'lemon', a: 'orange', b: 'banana', c: 'apple'}
// example 1: ksort($data)
// example 1: var $result = $data
// returns 1: {a: 'orange', b: 'banana', c: 'apple', d: 'lemon'}
// example 2: ini_set('locutus.sortByReference', true)
// example 2: var $data = {2: 'van', 3: 'Zonneveld', 1: 'Kevin'}
// example 2: ksort($data)
// example 2: var $result = $data
// returns 2: {1: 'Kevin', 2: 'van', 3: 'Zonneveld'}
const tmpArr = {};
const keys = [];
let sorter;
let i;
let k;
let sortByReference = false;
let populateArr = {};
const runtime = ensurePhpRuntimeState();
switch (sortFlags) {
case 'SORT_STRING':
// compare items as strings
sorter = function (a, b) {
return Number(strnatcmp(b, a) ?? 0);
};
break;
case 'SORT_LOCALE_STRING': {
// compare items as strings, based on the current locale
// (set with i18n_loc_set_default() as of PHP6)
const loc = i18nlgd();
const locale = runtime.locales[loc];
if (locale?.sorting) {
sorter = locale.sorting;
}
break;
}
case 'SORT_NUMERIC':
// compare items numerically
sorter = function (a, b) {
return Number(a) - Number(b);
};
break;
default:
// case 'SORT_REGULAR': // compare items normally (don't change types)
sorter = function (a, b) {
const aFloat = parseFloat(a);
const bFloat = parseFloat(b);
const aNumeric = aFloat + '' === a;
const bNumeric = bFloat + '' === b;
if (aNumeric && bNumeric) {
return aFloat > bFloat ? 1 : aFloat < bFloat ? -1 : 0;
}
else if (aNumeric && !bNumeric) {
return 1;
}
else if (!aNumeric && bNumeric) {
return -1;
}
return a > b ? 1 : a < b ? -1 : 0;
};
break;
}
// Make a list of key names
for (k in inputArr) {
if (inputArr.hasOwnProperty(k)) {
keys.push(k);
}
}
keys.sort(sorter);
const iniVal = String(runtime.ini['locutus.sortByReference']?.local_value ?? '') || 'on';
sortByReference = iniVal === 'on';
populateArr = sortByReference ? inputArr : populateArr;
// Rebuild array with sorted key names
for (i = 0; i < keys.length; i++) {
const keyName = keys[i];
if (typeof keyName === 'undefined') {
continue;
}
k = keyName;
const value = inputArr[k];
if (sortByReference) {
delete inputArr[k];
}
if (typeof value === 'undefined') {
continue;
}
tmpArr[k] = value;
}
for (const i in tmpArr) {
if (tmpArr.hasOwnProperty(i)) {
const value = tmpArr[i];
if (typeof value === 'undefined') {
continue;
}
populateArr[i] = value;
}
}
return sortByReference || populateArr;
}