locutus/esm/php/array/uksort.js

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

import { resolvePhpCallable } from "../_helpers/_callbackResolver.js";
import { ensurePhpRuntimeState } from "../_helpers/_phpRuntimeState.js";
export function uksort(inputArr, sorter) {
    //  discuss at: https://locutus.io/php/uksort/
    // original by: Brett Zamir (https://brett-zamir.me)
    // improved by: Brett Zamir (https://brett-zamir.me)
    //      note 1: The examples are correct, this is a new way
    //      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 $data = {d: 'lemon', a: 'orange', b: 'banana', c: 'apple'}
    //   example 1: uksort($data, function (key1, key2){ return (key1 === key2 ? 0 : (key1 > key2 ? 1 : -1)); })
    //   example 1: var $result = $data
    //   returns 1: {a: 'orange', b: 'banana', c: 'apple', d: 'lemon'}
    const tmpArr = {};
    const keys = [];
    let i = 0;
    let k = '';
    let sortByReference = false;
    let populateArr = {};
    let comparator;
    if (sorter) {
        let normalizedSorter;
        if (typeof sorter === 'string') {
            if (!this.window) {
                return false;
            }
            normalizedSorter = [this.window, sorter];
        }
        else if (Array.isArray(sorter)) {
            const [scopeDescriptor, callableDescriptor] = sorter;
            if (typeof callableDescriptor === 'undefined') {
                return false;
            }
            const scopeValue = typeof scopeDescriptor === 'string'
                ? (this.window?.[scopeDescriptor] ?? this[scopeDescriptor])
                : scopeDescriptor;
            normalizedSorter = [scopeValue, callableDescriptor];
        }
        else {
            normalizedSorter = sorter;
        }
        try {
            const resolved = resolvePhpCallable(normalizedSorter, {
                invalidMessage: 'uksort(): Invalid callback',
                missingScopeMessage: (scopeName) => 'Object not found: ' + scopeName,
            });
            comparator = (a, b) => Number(resolved.fn.apply(resolved.scope, [a, b]));
        }
        catch (_error) {
            return false;
        }
    }
    // Make a list of key names
    for (k in inputArr) {
        if (inputArr.hasOwnProperty(k)) {
            keys.push(k);
        }
    }
    // Sort key names
    try {
        if (typeof comparator === 'function') {
            keys.sort(comparator);
        }
        else {
            keys.sort();
        }
    }
    catch (_e) {
        return false;
    }
    const runtime = ensurePhpRuntimeState();
    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 key = keys[i];
        if (key === undefined) {
            continue;
        }
        k = key;
        const value = inputArr[k];
        if (value === undefined) {
            continue;
        }
        tmpArr[k] = value;
        if (sortByReference) {
            delete inputArr[k];
        }
    }
    for (const i in tmpArr) {
        if (tmpArr.hasOwnProperty(i)) {
            const value = tmpArr[i];
            if (value === undefined) {
                continue;
            }
            populateArr[i] = value;
        }
    }
    return sortByReference || populateArr;
}