PHP's uksort in TypeScript

How to use

Install via yarn add locutus and import: import { uksort } from 'locutus/php/array/uksort'.

Or with CommonJS: const { uksort } = require('locutus/php/array/uksort')

Use a bundler that supports tree-shaking so you only ship the functions you actually use. Vite, webpack, Rollup, and Parcel all handle this. For server-side use this is less of a concern.

Examples

These examples are extracted from test cases that automatically verify our functions against their native counterparts.

#	code	expected result
1	var $data = {d: 'lemon', a: 'orange', b: 'banana', c: 'apple'} uksort($data, function (key1, key2){ return (key1 === key2 ? 0 : (key1 > key2 ? 1 : -1)); }) var $result = $data	{a: 'orange', b: 'banana', c: 'apple', d: 'lemon'}

PHP arrays and TypeScript/JavaScript

Please note that Locutus uses TypeScript/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 TypeScript/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.

In practice most engines preserve insertion order, but if your code depends on key ordering across platforms, keep this caveat in mind.

To influence how Locutus treats objects as arrays, you can check out the locutus.objectsAsArrays setting.

Notes

• The examples are correct, this is a new way This function deviates from PHP in returning a copy of the array instead of acting by reference and returning true; this was necessary because IE does not allow deleting and re-adding of properties without caching of property position; you can set the ini of “locutus.sortByReference” to true to get the PHP behavior, but use this only if you are in an environment such as Firefox extensions where for-in iteration order is fixed and true property deletion is supported. Note that we intend to implement the PHP behavior by default if IE ever does allow it; only gives shallow copy since is by reference in PHP anyways

Dependencies

This function uses the following Locutus functions:

• _callbackResolver (php/_helpers)
• _phpRuntimeState (php/_helpers)

Here's what our current TypeScript equivalent to PHP's uksort looks like.

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

import { resolvePhpCallable } from '../_helpers/_callbackResolver.ts'
import { ensurePhpRuntimeState } from '../_helpers/_phpRuntimeState.ts'
import {
  type NumericLike,
  type PhpAssoc,
  type PhpKeyComparatorDescriptor,
  type PhpRuntimeValue,
} from '../_helpers/_phpTypes.ts'

type SortContextValue = PhpRuntimeValue

export function uksort<T>(
  this: PhpAssoc<SortContextValue> & { window?: PhpAssoc<SortContextValue> },
  inputArr: Record<string, T>,
  sorter: PhpKeyComparatorDescriptor,
): boolean | Record<string, T> {
  //  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: Record<string, T> = {}
  const keys: string[] = []
  let i = 0
  let k = ''
  let sortByReference = false
  let populateArr: Record<string, T> = {}
  let comparator: ((a: string, b: string) => number) | undefined

  if (sorter) {
    let normalizedSorter: PhpKeyComparatorDescriptor
    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: SortContextValue =
        typeof scopeDescriptor === 'string'
          ? (this.window?.[scopeDescriptor] ?? this[scopeDescriptor])
          : scopeDescriptor
      normalizedSorter = [scopeValue, callableDescriptor]
    } else {
      normalizedSorter = sorter
    }

    try {
      const resolved = resolvePhpCallable<[string, string], NumericLike>(normalizedSorter, {
        invalidMessage: 'uksort(): Invalid callback',
        missingScopeMessage: (scopeName: string) => 'Object not found: ' + scopeName,
      })
      comparator = (a: string, b: string): number => 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
}

import { resolvePhpCallable } from '../_helpers/_callbackResolver.ts'
import { ensurePhpRuntimeState } from '../_helpers/_phpRuntimeState.ts'

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
}

// php/_helpers/_phpTypes (Locutus helper dependency)
type PhpNullish = null | undefined

type PhpInput = {} | PhpNullish

type PhpScalar = string | number | boolean

type PhpPrimitive = PhpScalar | bigint

type NumericLike = number | bigint | string

type PhpList<T = PhpInput> = T[]

type PhpAssoc<T = PhpInput> = { [key: string]: T }

type PhpArrayLike<T = PhpInput> = PhpList<T> | PhpAssoc<T>

type PhpFunctionValue = (...args: PhpInput[]) => PhpInput

interface PhpRuntimeAssoc {
  [key: string]: PhpRuntimeValue
}

interface PhpRuntimeList extends Array<PhpRuntimeValue> {}

type PhpRuntimeValue = PhpPrimitive | PhpNullish | PhpRuntimeList | PhpRuntimeAssoc | PhpFunctionValue

type PhpCallableArgs = PhpInput[]

type PhpCallable<TArgs extends PhpCallableArgs = PhpCallableArgs, TResult = PhpInput> = (
  ...args: TArgs
) => TResult

type PhpCallableScope = PhpInput

type PhpCallableTuple<TArgs extends PhpCallableArgs = PhpCallableArgs, TResult = PhpInput> = readonly [
  PhpCallableScope,
  string | PhpCallable<TArgs, TResult>,
]

type PhpCallableDescriptor<TArgs extends PhpCallableArgs = PhpCallableArgs, TResult = PhpInput> =
  | string
  | PhpCallable<TArgs, TResult>
  | PhpCallableTuple<TArgs, TResult>

type PhpKeyComparatorDescriptor = PhpCallableDescriptor<[string, string], NumericLike>

function isPhpList<T = PhpInput>(value: PhpInput): value is PhpList<T> {
  return Array.isArray(value)
}

function isObjectLike(value: PhpInput): value is PhpArrayLike<PhpInput> {
  return typeof value === 'object' && value !== null
}

function isPhpAssocObject<T = PhpInput>(value: PhpInput): value is PhpAssoc<T> {
  return isObjectLike(value) && !isPhpList(value)
}

function isPhpCallable<TArgs extends PhpCallableArgs = PhpCallableArgs, TResult = PhpInput>(
  value: PhpInput,
): value is PhpCallable<TArgs, TResult> {
  return typeof value === 'function'
}

// php/_helpers/_phpRuntimeState (Locutus helper dependency)
interface IniEntry {
  local_value?: PhpInput
}

type LocaleEntry = PhpAssoc<PhpInput> & {
  sorting?: (left: PhpInput, right: PhpInput) => number
}

type LocaleCategoryMap = PhpAssoc<string | undefined>

interface LocutusRuntimeContainer {
  php?: PhpAssoc<PhpInput>
}

interface PhpGlobalProcessLike {
  env?: PhpAssoc<string | undefined>
}

interface PhpGlobalBufferLike {
  from?: (...args: PhpInput[]) => PhpInput
}

interface PhpGlobalKnownEntryMap {
  process: PhpGlobalProcessLike
  Buffer: PhpGlobalBufferLike
}

type GlobalWithLocutus = {
  $locutus?: LocutusRuntimeContainer
  [key: string]: PhpInput
}

interface PhpRuntimeState {
  ini: PhpAssoc<IniEntry | undefined>
  locales: PhpAssoc<LocaleEntry | undefined>
  localeCategories: LocaleCategoryMap
  pointers: PhpList<PhpInput>
  locale_default: string | undefined
}

const isIniBag = (value: PhpInput): value is PhpAssoc<IniEntry | undefined> =>
  isPhpAssocObject<IniEntry | undefined>(value)

const isLocaleBag = (value: PhpInput): value is PhpAssoc<LocaleEntry | undefined> =>
  isPhpAssocObject<LocaleEntry | undefined>(value)

const isLocaleCategoryBag = (value: PhpInput): value is LocaleCategoryMap => isPhpAssocObject<string | undefined>(value)

const globalContext: GlobalWithLocutus =
  typeof window === 'object' && window !== null ? window : typeof global === 'object' && global !== null ? global : {}

const ensurePhpRuntimeObject = (): PhpAssoc<PhpInput> => {
  let locutus = globalContext.$locutus
  if (typeof locutus !== 'object' || locutus === null) {
    locutus = {}
    globalContext.$locutus = locutus
  }

  let php = locutus.php
  if (typeof php !== 'object' || php === null) {
    php = {}
    locutus.php = php
  }

  return php
}

function ensurePhpRuntimeState(): PhpRuntimeState {
  const php = ensurePhpRuntimeObject()
  const iniValue = php.ini
  const localesValue = php.locales
  const localeCategoriesValue = php.localeCategories
  const pointersValue = php.pointers

  const ini = isIniBag(iniValue) ? iniValue : {}
  const locales = isLocaleBag(localesValue) ? localesValue : {}
  const localeCategories = isLocaleCategoryBag(localeCategoriesValue) ? localeCategoriesValue : {}
  const pointers: PhpList<PhpInput> = Array.isArray(pointersValue) ? pointersValue : []

  if (iniValue !== ini) {
    php.ini = ini
  }
  if (localesValue !== locales) {
    php.locales = locales
  }
  if (localeCategoriesValue !== localeCategories) {
    php.localeCategories = localeCategories
  }
  if (pointersValue !== pointers) {
    php.pointers = pointers
  }

  const localeDefaultValue = php.locale_default
  const localeDefault = typeof localeDefaultValue === 'string' ? localeDefaultValue : undefined

  return {
    ini,
    locales,
    localeCategories,
    pointers,
    locale_default: localeDefault,
  }
}

function getPhpGlobalEntry<TKey extends keyof PhpGlobalKnownEntryMap>(
  key: TKey,
): PhpGlobalKnownEntryMap[TKey] | undefined

function getPhpGlobalEntry(key: string): PhpInput | undefined

function getPhpGlobalEntry(key: string): PhpInput | undefined {
  const value = globalContext[key]
  return typeof value === 'undefined' ? undefined : value
}

function getPhpObjectEntry(value: PhpInput, key: string): PhpInput | undefined {
  if ((typeof value !== 'object' && typeof value !== 'function') || value === null) {
    return undefined
  }

  let current: object | null = value
  while (current) {
    const descriptor = Object.getOwnPropertyDescriptor(current, key)
    if (descriptor) {
      if (typeof descriptor.get === 'function') {
        const getterValue = descriptor.get.call(value)
        return typeof getterValue === 'undefined' ? undefined : getterValue
      }
      const directValue = descriptor.value
      return typeof directValue === 'undefined' ? undefined : directValue
    }
    current = Object.getPrototypeOf(current)
  }

  return undefined
}

// php/_helpers/_callbackResolver (Locutus helper dependency)
type CallbackValue = PhpInput

interface CallbackResolverOptions {
  invalidMessage: string
  missingScopeMessage?: (scopeName: string) => string
}

interface ResolvedCallback<TArgs extends PhpCallableArgs = PhpCallableArgs, TResult = CallbackValue> {
  fn: PhpCallable<TArgs, TResult>
  scope: CallbackValue
}

function resolvePhpCallable<TArgs extends PhpCallableArgs = PhpCallableArgs, TResult = CallbackValue>(
  callback: PhpCallableDescriptor<TArgs, TResult>,
  options: CallbackResolverOptions,
): ResolvedCallback<TArgs, TResult> {
  if (isPhpCallable<TArgs, TResult>(callback)) {
    return { fn: callback, scope: null }
  }

  if (typeof callback === 'string') {
    const candidate = getPhpGlobalEntry(callback)
    if (isPhpCallable<TArgs, TResult>(candidate)) {
      return { fn: candidate, scope: null }
    }
    throw new Error(options.invalidMessage)
  }

  if (Array.isArray(callback) && callback.length >= 2) {
    const scopeDescriptor = callback[0]
    const callableDescriptor = callback[1]

    let scope: CallbackValue
    if (typeof scopeDescriptor === 'string') {
      scope = getPhpGlobalEntry(scopeDescriptor)
      if (typeof scope === 'undefined' && options.missingScopeMessage) {
        throw new Error(options.missingScopeMessage(scopeDescriptor))
      }
    } else {
      scope = scopeDescriptor
    }

    if (isPhpCallable<TArgs, TResult>(callableDescriptor)) {
      return { fn: callableDescriptor, scope }
    }

    if (typeof callableDescriptor === 'string' && (isObjectLike(scope) || typeof scope === 'function')) {
      const candidate = getPhpObjectEntry(scope, callableDescriptor)
      if (isPhpCallable<TArgs, TResult>(candidate)) {
        return { fn: candidate, scope }
      }
    }
  }

  throw new Error(options.invalidMessage)
}

// php/array/uksort (target function module)
type SortContextValue = PhpRuntimeValue

function uksort<T>(
  this: PhpAssoc<SortContextValue> & { window?: PhpAssoc<SortContextValue> },
  inputArr: Record<string, T>,
  sorter: PhpKeyComparatorDescriptor,
): boolean | Record<string, T> {
  //  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: Record<string, T> = {}
  const keys: string[] = []
  let i = 0
  let k = ''
  let sortByReference = false
  let populateArr: Record<string, T> = {}
  let comparator: ((a: string, b: string) => number) | undefined

  if (sorter) {
    let normalizedSorter: PhpKeyComparatorDescriptor
    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: SortContextValue =
        typeof scopeDescriptor === 'string'
          ? (this.window?.[scopeDescriptor] ?? this[scopeDescriptor])
          : scopeDescriptor
      normalizedSorter = [scopeValue, callableDescriptor]
    } else {
      normalizedSorter = sorter
    }

    try {
      const resolved = resolvePhpCallable<[string, string], NumericLike>(normalizedSorter, {
        invalidMessage: 'uksort(): Invalid callback',
        missingScopeMessage: (scopeName: string) => 'Object not found: ' + scopeName,
      })
      comparator = (a: string, b: string): number => 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
}

// php/_helpers/_phpTypes (Locutus helper dependency)

function isObjectLike(value) {
  return typeof value === 'object' && value !== null
}

function isPhpAssocObject(value) {
  return isObjectLike(value) && !Array.isArray(value)
}

function isPhpCallable(value) {
  return typeof value === 'function'
}

// php/_helpers/_phpRuntimeState (Locutus helper dependency)

const globalContext =
  typeof window === 'object' && window !== null ? window : typeof global === 'object' && global !== null ? global : {}

const ensurePhpRuntimeObject = () => {
  let locutus = globalContext.$locutus
  if (typeof locutus !== 'object' || locutus === null) {
    locutus = {}
    globalContext.$locutus = locutus
  }

  let php = locutus.php
  if (typeof php !== 'object' || php === null) {
    php = {}
    locutus.php = php
  }

  return php
}

function ensurePhpRuntimeState() {
  const php = ensurePhpRuntimeObject()
  const iniValue = php.ini
  const localesValue = php.locales
  const localeCategoriesValue = php.localeCategories
  const pointersValue = php.pointers

  const ini = isPhpAssocObject(iniValue) ? iniValue : {}
  const locales = isPhpAssocObject(localesValue) ? localesValue : {}
  const localeCategories = isPhpAssocObject(localeCategoriesValue) ? localeCategoriesValue : {}
  const pointers = Array.isArray(pointersValue) ? pointersValue : []

  if (iniValue !== ini) {
    php.ini = ini
  }
  if (localesValue !== locales) {
    php.locales = locales
  }
  if (localeCategoriesValue !== localeCategories) {
    php.localeCategories = localeCategories
  }
  if (pointersValue !== pointers) {
    php.pointers = pointers
  }

  const localeDefaultValue = php.locale_default
  const localeDefault = typeof localeDefaultValue === 'string' ? localeDefaultValue : undefined

  return {
    ini,
    locales,
    localeCategories,
    pointers,
    locale_default: localeDefault,
  }
}

function getPhpGlobalEntry(key) {
  const value = globalContext[key]
  return typeof value === 'undefined' ? undefined : value
}

function getPhpObjectEntry(value, key) {
  if ((typeof value !== 'object' && typeof value !== 'function') || value === null) {
    return undefined
  }

  let current = value
  while (current) {
    const descriptor = Object.getOwnPropertyDescriptor(current, key)
    if (descriptor) {
      if (typeof descriptor.get === 'function') {
        const getterValue = descriptor.get.call(value)
        return typeof getterValue === 'undefined' ? undefined : getterValue
      }
      const directValue = descriptor.value
      return typeof directValue === 'undefined' ? undefined : directValue
    }
    current = Object.getPrototypeOf(current)
  }

  return undefined
}

// php/_helpers/_callbackResolver (Locutus helper dependency)
function resolvePhpCallable(callback, options) {
  if (isPhpCallable(callback)) {
    return { fn: callback, scope: null }
  }

  if (typeof callback === 'string') {
    const candidate = getPhpGlobalEntry(callback)
    if (isPhpCallable(candidate)) {
      return { fn: candidate, scope: null }
    }
    throw new Error(options.invalidMessage)
  }

  if (Array.isArray(callback) && callback.length >= 2) {
    const scopeDescriptor = callback[0]
    const callableDescriptor = callback[1]

    let scope
    if (typeof scopeDescriptor === 'string') {
      scope = getPhpGlobalEntry(scopeDescriptor)
      if (typeof scope === 'undefined' && options.missingScopeMessage) {
        throw new Error(options.missingScopeMessage(scopeDescriptor))
      }
    } else {
      scope = scopeDescriptor
    }

    if (isPhpCallable(callableDescriptor)) {
      return { fn: callableDescriptor, scope }
    }

    if (typeof callableDescriptor === 'string' && (isObjectLike(scope) || typeof scope === 'function')) {
      const candidate = getPhpObjectEntry(scope, callableDescriptor)
      if (isPhpCallable(candidate)) {
        return { fn: candidate, scope }
      }
    }
  }

  throw new Error(options.invalidMessage)
}

// php/array/uksort (target function module)
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
}

Improve this function

Locutus is a community effort following The McDonald's Theory: we ship first iterations, hoping others will improve them. If you see something that could be better, we'd love your contribution.

View on GitHub · Edit on GitHub · View Raw

---

« More PHP array functions

Star