PHP's arsort in TypeScript

How to use

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

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

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'} arsort($data) var $result = $data	{a: 'orange', d: 'lemon', b: 'banana', c: 'apple'}
2	ini_set('locutus.sortByReference', true) var $data = {d: 'lemon', a: 'orange', b: 'banana', c: 'apple'} arsort($data) var $result = $data	{a: 'orange', d: 'lemon', b: 'banana', c: 'apple'}

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

• SORT_STRING (as well as natsort and natcasesort) might also be integrated into all of these functions by adapting the code at https://sourcefrog.net/projects/natsort/natcompare.js The examples are correct, this is a new way Credits to: https://javascript.internet.com/math-related/bubble-sort.html 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 Since JS objects’ keys are always strings, and (the default) SORT_REGULAR flag distinguishes by key type, if the content is a numeric string, we treat the “original type” as numeric.

Dependencies

This function uses the following Locutus functions:

• _phpRuntimeState (php/_helpers)
• i18n_loc_get_default (php/i18n)
• strnatcmp (php/strings)

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

import { ensurePhpRuntimeState } from '../_helpers/_phpRuntimeState.ts'
import type { PhpRuntimeValue } from '../_helpers/_phpTypes.ts'
import { i18n_loc_get_default as i18lgd } from '../i18n/i18n_loc_get_default.ts'
import { strnatcmp } from '../strings/strnatcmp.ts'

type SortValue = PhpRuntimeValue
type SortFlag = 'SORT_REGULAR' | 'SORT_NUMERIC' | 'SORT_STRING' | 'SORT_LOCALE_STRING'

const toSortablePrimitive = (value: SortValue): string | number | bigint | boolean => {
  if (
    typeof value === 'string' ||
    typeof value === 'number' ||
    typeof value === 'bigint' ||
    typeof value === 'boolean'
  ) {
    return value
  }

  return String(value ?? '')
}

export function arsort<T extends SortValue>(
  inputArr: Record<string, T>,
  sortFlags?: SortFlag,
): boolean | Record<string, T> {
  //  discuss at: https://locutus.io/php/arsort/
  // 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: SORT_STRING (as well as natsort and natcasesort) might also be
  //      note 1: integrated into all of these functions by adapting the code at
  //      note 1: https://sourcefrog.net/projects/natsort/natcompare.js
  //      note 1: The examples are correct, this is a new way
  //      note 1: Credits to: https://javascript.internet.com/math-related/bubble-sort.html
  //      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: arsort($data)
  //   example 1: var $result = $data
  //   returns 1: {a: 'orange', d: 'lemon', b: 'banana', c: 'apple'}
  //   example 2: ini_set('locutus.sortByReference', true)
  //   example 2: var $data = {d: 'lemon', a: 'orange', b: 'banana', c: 'apple'}
  //   example 2: arsort($data)
  //   example 2: var $result = $data
  //   returns 2: {a: 'orange', d: 'lemon', b: 'banana', c: 'apple'}

  const runtime = ensurePhpRuntimeState()
  const valArr: [string, T][] = []

  const regularSortDesc = (leftValue: T, rightValue: T): number => {
    const left = toSortablePrimitive(leftValue)
    const right = toSortablePrimitive(rightValue)
    return left < right ? 1 : left > right ? -1 : 0
  }

  let sorter: (a: T, b: T) => number = regularSortDesc

  switch (sortFlags) {
    case 'SORT_STRING':
      sorter = (a, b) => Number(strnatcmp(b, a) ?? 0)
      break
    case 'SORT_LOCALE_STRING': {
      const locale = runtime.locales[i18lgd()]
      if (locale?.sorting) {
        sorter = locale.sorting
      }
      break
    }
    case 'SORT_NUMERIC':
      sorter = (a, b) => Number(a) - Number(b)
      break
    case 'SORT_REGULAR':
      sorter = regularSortDesc
      break
    default:
      sorter = regularSortDesc
      break
  }

  const iniVal = String(runtime.ini['locutus.sortByReference']?.local_value ?? '') || 'on'
  const sortByReference = iniVal === 'on'
  const populateArr: Record<string, T> = {}

  for (const [key, value] of Object.entries(inputArr)) {
    valArr.push([key, value])
    if (sortByReference) {
      delete inputArr[key]
    }
  }

  valArr.sort((a, b) => sorter(a[1], b[1]))

  for (const [key, value] of valArr) {
    populateArr[key] = value
    if (sortByReference) {
      inputArr[key] = value
    }
  }

  return sortByReference || populateArr
}

import { ensurePhpRuntimeState } from '../_helpers/_phpRuntimeState.ts'
import { i18n_loc_get_default as i18lgd } from '../i18n/i18n_loc_get_default.ts'
import { strnatcmp } from '../strings/strnatcmp.ts'

const toSortablePrimitive = (value) => {
  if (
    typeof value === 'string' ||
    typeof value === 'number' ||
    typeof value === 'bigint' ||
    typeof value === 'boolean'
  ) {
    return value
  }

  return String(value ?? '')
}

export function arsort(inputArr, sortFlags) {
  //  discuss at: https://locutus.io/php/arsort/
  // 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: SORT_STRING (as well as natsort and natcasesort) might also be
  //      note 1: integrated into all of these functions by adapting the code at
  //      note 1: https://sourcefrog.net/projects/natsort/natcompare.js
  //      note 1: The examples are correct, this is a new way
  //      note 1: Credits to: https://javascript.internet.com/math-related/bubble-sort.html
  //      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: arsort($data)
  //   example 1: var $result = $data
  //   returns 1: {a: 'orange', d: 'lemon', b: 'banana', c: 'apple'}
  //   example 2: ini_set('locutus.sortByReference', true)
  //   example 2: var $data = {d: 'lemon', a: 'orange', b: 'banana', c: 'apple'}
  //   example 2: arsort($data)
  //   example 2: var $result = $data
  //   returns 2: {a: 'orange', d: 'lemon', b: 'banana', c: 'apple'}

  const runtime = ensurePhpRuntimeState()
  const valArr = []

  const regularSortDesc = (leftValue, rightValue) => {
    const left = toSortablePrimitive(leftValue)
    const right = toSortablePrimitive(rightValue)
    return left < right ? 1 : left > right ? -1 : 0
  }

  let sorter = regularSortDesc

  switch (sortFlags) {
    case 'SORT_STRING':
      sorter = (a, b) => Number(strnatcmp(b, a) ?? 0)
      break
    case 'SORT_LOCALE_STRING': {
      const locale = runtime.locales[i18lgd()]
      if (locale?.sorting) {
        sorter = locale.sorting
      }
      break
    }
    case 'SORT_NUMERIC':
      sorter = (a, b) => Number(a) - Number(b)
      break
    case 'SORT_REGULAR':
      sorter = regularSortDesc
      break
    default:
      sorter = regularSortDesc
      break
  }

  const iniVal = String(runtime.ini['locutus.sortByReference']?.local_value ?? '') || 'on'
  const sortByReference = iniVal === 'on'
  const populateArr = {}

  for (const [key, value] of Object.entries(inputArr)) {
    valArr.push([key, value])
    if (sortByReference) {
      delete inputArr[key]
    }
  }

  valArr.sort((a, b) => sorter(a[1], b[1]))

  for (const [key, value] of valArr) {
    populateArr[key] = value
    if (sortByReference) {
      inputArr[key] = 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 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

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)
}

// 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>
}

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,
  }
}

// php/i18n/i18n_loc_get_default (Locutus dependency module)
function i18n_loc_get_default(): string {
  //  discuss at: https://locutus.io/php/i18n_loc_get_default/
  // original by: Brett Zamir (https://brett-zamir.me)
  //      note 1: Renamed in PHP6 from locale_get_default(). Not listed yet at php.net.
  //      note 1: List of locales at <https://demo.icu-project.org/icu-bin/locexp>
  //      note 1: To be usable with sort() if it is passed the `SORT_LOCALE_STRING`
  //      note 1: sorting flag: https://php.net/manual/en/function.sort.php
  //   example 1: i18n_loc_get_default()
  //   returns 1: 'en_US_POSIX'
  //   example 2: i18n_loc_set_default('pt_PT')
  //   example 2: i18n_loc_get_default()
  //   returns 2: 'pt_PT'

  const runtime = ensurePhpRuntimeState()
  return runtime.locale_default ?? 'en_US_POSIX'
}

// php/_helpers/_phpCastString (Locutus helper dependency)
type CastStringValue = PhpInput

function _phpCastString(value: CastStringValue): string {
  // original by: Rafał Kukawski

  if (typeof value === 'boolean') {
    return value ? '1' : ''
  }
  if (typeof value === 'string') {
    return value
  }
  if (typeof value === 'number') {
    if (isNaN(value)) {
      return 'NAN'
    }

    if (!isFinite(value)) {
      return (value < 0 ? '-' : '') + 'INF'
    }

    return value + ''
  }
  if (typeof value === 'undefined') {
    return ''
  }
  if (typeof value === 'object') {
    if (Array.isArray(value)) {
      return 'Array'
    }

    if (value !== null) {
      return 'Object'
    }

    return ''
  }

  throw new Error('Unsupported value type')
}

// php/strings/strnatcmp (Locutus dependency module)
type NatCmpValue = PhpRuntimeValue

function strnatcmp(left: NatCmpValue, right: NatCmpValue): number {
  //       discuss at: https://locutus.io/php/strnatcmp/
  //  parity verified: PHP 8.3
  //      original by: Martijn Wieringa
  //      improved by: Michael White (https://getsprink.com)
  //      improved by: Jack
  //      bugfixed by: Onno Marsman (https://twitter.com/onnomarsman)
  // reimplemented by: Rafał Kukawski
  //        example 1: strnatcmp('abc', 'abc')
  //        returns 1: 0
  //        example 2: strnatcmp('a', 'b')
  //        returns 2: -1
  //        example 3: strnatcmp('10', '1')
  //        returns 3: 1
  //        example 4: strnatcmp('0000abc', '0abc')
  //        returns 4: 0
  //        example 5: strnatcmp('1239', '12345')
  //        returns 5: -1
  //        example 6: strnatcmp('t01239', 't012345')
  //        returns 6: 1
  //        example 7: strnatcmp('0A', '5N')
  //        returns 7: -1

  const leadingZeros = /^0+(?=\d)/
  const whitespace = /^\s/
  const digit = /^\d/

  let leftValue = _phpCastString(left)
  let rightValue = _phpCastString(right)

  if (!leftValue.length || !rightValue.length) {
    return leftValue.length - rightValue.length
  }

  let i = 0
  let j = 0

  leftValue = leftValue.replace(leadingZeros, '')
  rightValue = rightValue.replace(leadingZeros, '')

  while (i < leftValue.length && j < rightValue.length) {
    // skip consecutive whitespace
    while (whitespace.test(leftValue.charAt(i))) {
      i++
    }
    while (whitespace.test(rightValue.charAt(j))) {
      j++
    }

    let ac = leftValue.charAt(i)
    let bc = rightValue.charAt(j)
    let aIsDigit = digit.test(ac)
    let bIsDigit = digit.test(bc)

    if (aIsDigit && bIsDigit) {
      let bias = 0
      const fractional = ac === '0' || bc === '0'

      do {
        if (!aIsDigit) {
          return -1
        } else if (!bIsDigit) {
          return 1
        } else if (ac < bc) {
          if (!bias) {
            bias = -1
          }

          if (fractional) {
            return -1
          }
        } else if (ac > bc) {
          if (!bias) {
            bias = 1
          }

          if (fractional) {
            return 1
          }
        }

        ac = leftValue.charAt(++i)
        bc = rightValue.charAt(++j)

        aIsDigit = digit.test(ac)
        bIsDigit = digit.test(bc)
      } while (aIsDigit || bIsDigit)

      if (!fractional && bias) {
        return bias
      }

      continue
    }

    if (!ac || !bc) {
      continue
    } else if (ac < bc) {
      return -1
    } else if (ac > bc) {
      return 1
    }

    i++
    j++
  }

  const iBeforeStrEnd = i < leftValue.length
  const jBeforeStrEnd = j < rightValue.length

  // Check which string ended first
  // return -1 if a, 1 if b, 0 otherwise
  if (iBeforeStrEnd && !jBeforeStrEnd) {
    return 1
  }
  if (!iBeforeStrEnd && jBeforeStrEnd) {
    return -1
  }
  return 0
}

// php/array/arsort (target function module)
const i18lgd = i18n_loc_get_default;

type SortValue = PhpRuntimeValue

type SortFlag = 'SORT_REGULAR' | 'SORT_NUMERIC' | 'SORT_STRING' | 'SORT_LOCALE_STRING'

const toSortablePrimitive = (value: SortValue): string | number | bigint | boolean => {
  if (
    typeof value === 'string' ||
    typeof value === 'number' ||
    typeof value === 'bigint' ||
    typeof value === 'boolean'
  ) {
    return value
  }

  return String(value ?? '')
}

function arsort<T extends SortValue>(
  inputArr: Record<string, T>,
  sortFlags?: SortFlag,
): boolean | Record<string, T> {
  //  discuss at: https://locutus.io/php/arsort/
  // 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: SORT_STRING (as well as natsort and natcasesort) might also be
  //      note 1: integrated into all of these functions by adapting the code at
  //      note 1: https://sourcefrog.net/projects/natsort/natcompare.js
  //      note 1: The examples are correct, this is a new way
  //      note 1: Credits to: https://javascript.internet.com/math-related/bubble-sort.html
  //      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: arsort($data)
  //   example 1: var $result = $data
  //   returns 1: {a: 'orange', d: 'lemon', b: 'banana', c: 'apple'}
  //   example 2: ini_set('locutus.sortByReference', true)
  //   example 2: var $data = {d: 'lemon', a: 'orange', b: 'banana', c: 'apple'}
  //   example 2: arsort($data)
  //   example 2: var $result = $data
  //   returns 2: {a: 'orange', d: 'lemon', b: 'banana', c: 'apple'}

  const runtime = ensurePhpRuntimeState()
  const valArr: [string, T][] = []

  const regularSortDesc = (leftValue: T, rightValue: T): number => {
    const left = toSortablePrimitive(leftValue)
    const right = toSortablePrimitive(rightValue)
    return left < right ? 1 : left > right ? -1 : 0
  }

  let sorter: (a: T, b: T) => number = regularSortDesc

  switch (sortFlags) {
    case 'SORT_STRING':
      sorter = (a, b) => Number(strnatcmp(b, a) ?? 0)
      break
    case 'SORT_LOCALE_STRING': {
      const locale = runtime.locales[i18lgd()]
      if (locale?.sorting) {
        sorter = locale.sorting
      }
      break
    }
    case 'SORT_NUMERIC':
      sorter = (a, b) => Number(a) - Number(b)
      break
    case 'SORT_REGULAR':
      sorter = regularSortDesc
      break
    default:
      sorter = regularSortDesc
      break
  }

  const iniVal = String(runtime.ini['locutus.sortByReference']?.local_value ?? '') || 'on'
  const sortByReference = iniVal === 'on'
  const populateArr: Record<string, T> = {}

  for (const [key, value] of Object.entries(inputArr)) {
    valArr.push([key, value])
    if (sortByReference) {
      delete inputArr[key]
    }
  }

  valArr.sort((a, b) => sorter(a[1], b[1]))

  for (const [key, value] of valArr) {
    populateArr[key] = value
    if (sortByReference) {
      inputArr[key] = 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)
}

// 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,
  }
}

// php/i18n/i18n_loc_get_default (Locutus dependency module)
function i18n_loc_get_default() {
  //  discuss at: https://locutus.io/php/i18n_loc_get_default/
  // original by: Brett Zamir (https://brett-zamir.me)
  //      note 1: Renamed in PHP6 from locale_get_default(). Not listed yet at php.net.
  //      note 1: List of locales at <https://demo.icu-project.org/icu-bin/locexp>
  //      note 1: To be usable with sort() if it is passed the `SORT_LOCALE_STRING`
  //      note 1: sorting flag: https://php.net/manual/en/function.sort.php
  //   example 1: i18n_loc_get_default()
  //   returns 1: 'en_US_POSIX'
  //   example 2: i18n_loc_set_default('pt_PT')
  //   example 2: i18n_loc_get_default()
  //   returns 2: 'pt_PT'

  const runtime = ensurePhpRuntimeState()
  return runtime.locale_default ?? 'en_US_POSIX'
}

// php/_helpers/_phpCastString (Locutus helper dependency)
function _phpCastString(value) {
  // original by: Rafał Kukawski

  if (typeof value === 'boolean') {
    return value ? '1' : ''
  }
  if (typeof value === 'string') {
    return value
  }
  if (typeof value === 'number') {
    if (isNaN(value)) {
      return 'NAN'
    }

    if (!isFinite(value)) {
      return (value < 0 ? '-' : '') + 'INF'
    }

    return value + ''
  }
  if (typeof value === 'undefined') {
    return ''
  }
  if (typeof value === 'object') {
    if (Array.isArray(value)) {
      return 'Array'
    }

    if (value !== null) {
      return 'Object'
    }

    return ''
  }

  throw new Error('Unsupported value type')
}

// php/strings/strnatcmp (Locutus dependency module)
function strnatcmp(left, right) {
  //       discuss at: https://locutus.io/php/strnatcmp/
  //  parity verified: PHP 8.3
  //      original by: Martijn Wieringa
  //      improved by: Michael White (https://getsprink.com)
  //      improved by: Jack
  //      bugfixed by: Onno Marsman (https://twitter.com/onnomarsman)
  // reimplemented by: Rafał Kukawski
  //        example 1: strnatcmp('abc', 'abc')
  //        returns 1: 0
  //        example 2: strnatcmp('a', 'b')
  //        returns 2: -1
  //        example 3: strnatcmp('10', '1')
  //        returns 3: 1
  //        example 4: strnatcmp('0000abc', '0abc')
  //        returns 4: 0
  //        example 5: strnatcmp('1239', '12345')
  //        returns 5: -1
  //        example 6: strnatcmp('t01239', 't012345')
  //        returns 6: 1
  //        example 7: strnatcmp('0A', '5N')
  //        returns 7: -1

  const leadingZeros = /^0+(?=\d)/
  const whitespace = /^\s/
  const digit = /^\d/

  let leftValue = _phpCastString(left)
  let rightValue = _phpCastString(right)

  if (!leftValue.length || !rightValue.length) {
    return leftValue.length - rightValue.length
  }

  let i = 0
  let j = 0

  leftValue = leftValue.replace(leadingZeros, '')
  rightValue = rightValue.replace(leadingZeros, '')

  while (i < leftValue.length && j < rightValue.length) {
    // skip consecutive whitespace
    while (whitespace.test(leftValue.charAt(i))) {
      i++
    }
    while (whitespace.test(rightValue.charAt(j))) {
      j++
    }

    let ac = leftValue.charAt(i)
    let bc = rightValue.charAt(j)
    let aIsDigit = digit.test(ac)
    let bIsDigit = digit.test(bc)

    if (aIsDigit && bIsDigit) {
      let bias = 0
      const fractional = ac === '0' || bc === '0'

      do {
        if (!aIsDigit) {
          return -1
        } else if (!bIsDigit) {
          return 1
        } else if (ac < bc) {
          if (!bias) {
            bias = -1
          }

          if (fractional) {
            return -1
          }
        } else if (ac > bc) {
          if (!bias) {
            bias = 1
          }

          if (fractional) {
            return 1
          }
        }

        ac = leftValue.charAt(++i)
        bc = rightValue.charAt(++j)

        aIsDigit = digit.test(ac)
        bIsDigit = digit.test(bc)
      } while (aIsDigit || bIsDigit)

      if (!fractional && bias) {
        return bias
      }

      continue
    }

    if (!ac || !bc) {
      continue
    } else if (ac < bc) {
      return -1
    } else if (ac > bc) {
      return 1
    }

    i++
    j++
  }

  const iBeforeStrEnd = i < leftValue.length
  const jBeforeStrEnd = j < rightValue.length

  // Check which string ended first
  // return -1 if a, 1 if b, 0 otherwise
  if (iBeforeStrEnd && !jBeforeStrEnd) {
    return 1
  }
  if (!iBeforeStrEnd && jBeforeStrEnd) {
    return -1
  }
  return 0
}

// php/array/arsort (target function module)
const i18lgd = i18n_loc_get_default

const toSortablePrimitive = (value) => {
  if (
    typeof value === 'string' ||
    typeof value === 'number' ||
    typeof value === 'bigint' ||
    typeof value === 'boolean'
  ) {
    return value
  }

  return String(value ?? '')
}

function arsort(inputArr, sortFlags) {
  //  discuss at: https://locutus.io/php/arsort/
  // 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: SORT_STRING (as well as natsort and natcasesort) might also be
  //      note 1: integrated into all of these functions by adapting the code at
  //      note 1: https://sourcefrog.net/projects/natsort/natcompare.js
  //      note 1: The examples are correct, this is a new way
  //      note 1: Credits to: https://javascript.internet.com/math-related/bubble-sort.html
  //      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: arsort($data)
  //   example 1: var $result = $data
  //   returns 1: {a: 'orange', d: 'lemon', b: 'banana', c: 'apple'}
  //   example 2: ini_set('locutus.sortByReference', true)
  //   example 2: var $data = {d: 'lemon', a: 'orange', b: 'banana', c: 'apple'}
  //   example 2: arsort($data)
  //   example 2: var $result = $data
  //   returns 2: {a: 'orange', d: 'lemon', b: 'banana', c: 'apple'}

  const runtime = ensurePhpRuntimeState()
  const valArr = []

  const regularSortDesc = (leftValue, rightValue) => {
    const left = toSortablePrimitive(leftValue)
    const right = toSortablePrimitive(rightValue)
    return left < right ? 1 : left > right ? -1 : 0
  }

  let sorter = regularSortDesc

  switch (sortFlags) {
    case 'SORT_STRING':
      sorter = (a, b) => Number(strnatcmp(b, a) ?? 0)
      break
    case 'SORT_LOCALE_STRING': {
      const locale = runtime.locales[i18lgd()]
      if (locale?.sorting) {
        sorter = locale.sorting
      }
      break
    }
    case 'SORT_NUMERIC':
      sorter = (a, b) => Number(a) - Number(b)
      break
    case 'SORT_REGULAR':
      sorter = regularSortDesc
      break
    default:
      sorter = regularSortDesc
      break
  }

  const iniVal = String(runtime.ini['locutus.sortByReference']?.local_value ?? '') || 'on'
  const sortByReference = iniVal === 'on'
  const populateArr = {}

  for (const [key, value] of Object.entries(inputArr)) {
    valArr.push([key, value])
    if (sortByReference) {
      delete inputArr[key]
    }
  }

  valArr.sort((a, b) => sorter(a[1], b[1]))

  for (const [key, value] of valArr) {
    populateArr[key] = value
    if (sortByReference) {
      inputArr[key] = 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