locutus/esm/php/array/natsort.js

Locutus other languages' standard libraries to JavaScript for fun and educational purposes

import { ini_get } from "../info/ini_get.js";
import { strnatcmp } from "../strings/strnatcmp.js";
export function natsort(inputArr) {
    //      discuss at: https://locutus.io/php/natsort/
    // parity verified: PHP 8.3
    //     original by: Brett Zamir (https://brett-zamir.me)
    //     improved by: Brett Zamir (https://brett-zamir.me)
    //     improved by: Theriault (https://github.com/Theriault)
    //          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
    //       example 1: var $array1 = {a:"img12.png", b:"img10.png", c:"img2.png", d:"img1.png"}
    //       example 1: natsort($array1)
    //       example 1: var $result = $array1
    //       returns 1: {d: 'img1.png', c: 'img2.png', b: 'img10.png', a: 'img12.png'}
    const valArr = [];
    let k;
    let i;
    let sortByReference = false;
    let populateArr = {};
    const iniVal = ini_get('locutus.sortByReference') || 'on';
    sortByReference = iniVal === 'on';
    populateArr = sortByReference ? inputArr : populateArr;
    // Get key and value arrays
    for (k in inputArr) {
        if (inputArr.hasOwnProperty(k)) {
            const value = inputArr[k];
            if (value === undefined) {
                continue;
            }
            valArr.push([k, value]);
            if (sortByReference) {
                delete inputArr[k];
            }
        }
    }
    valArr.sort(function (a, b) {
        return Number(strnatcmp(a[1], b[1]) ?? 0);
    });
    // Repopulate the old array
    for (i = 0; i < valArr.length; i++) {
        const pair = valArr[i];
        if (!pair) {
            continue;
        }
        populateArr[pair[0]] = pair[1];
    }
    return sortByReference || populateArr;
}