PHP's natcasesort in TypeScript

✓ Verified: PHP 8.3

How to use

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

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

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 $array1 = {a:'IMG0.png', b:'img12.png', c:'img10.png', d:'img2.png', e:'img1.png', f:'IMG3.png'} natcasesort($array1) var $result = $array1`	`{a: 'IMG0.png', e: 'img1.png', d: 'img2.png', f: 'IMG3.png', c: 'img10.png', b: 'img12.png'}`

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

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 We cannot use numbers as keys and have them be reordered since they adhere to numerical order in some implementations

Dependencies

This function uses the following Locutus functions:

ini_get (php/info)
strnatcasecmp (php/strings)

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

import { ini_get } from '../info/ini_get.ts'
import { strnatcasecmp } from '../strings/strnatcasecmp.ts'

export function natcasesort<T extends string | number>(inputArr: Record<string, T>): boolean | Record<string, T> {
  //      discuss at: https://locutus.io/php/natcasesort/
  // 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
  //          note 1: We cannot use numbers as keys and have them be reordered since they
  //          note 1: adhere to numerical order in some implementations
  //       example 1: var $array1 = {a:'IMG0.png', b:'img12.png', c:'img10.png', d:'img2.png', e:'img1.png', f:'IMG3.png'}
  //       example 1: natcasesort($array1)
  //       example 1: var $result = $array1
  //       returns 1: {a: 'IMG0.png', e: 'img1.png', d: 'img2.png', f: 'IMG3.png', c: 'img10.png', b: 'img12.png'}

  const valArr: [string, T][] = []
  let k: string
  let i: number
  let sortByReference = false
  let populateArr: Record<string, T> = {}

  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(strnatcasecmp(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
}

import { ini_get } from '../info/ini_get.ts'
import { strnatcasecmp } from '../strings/strnatcasecmp.ts'

export function natcasesort(inputArr) {
  //      discuss at: https://locutus.io/php/natcasesort/
  // 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
  //          note 1: We cannot use numbers as keys and have them be reordered since they
  //          note 1: adhere to numerical order in some implementations
  //       example 1: var $array1 = {a:'IMG0.png', b:'img12.png', c:'img10.png', d:'img2.png', e:'img1.png', f:'IMG3.png'}
  //       example 1: natcasesort($array1)
  //       example 1: var $result = $array1
  //       returns 1: {a: 'IMG0.png', e: 'img1.png', d: 'img2.png', f: 'IMG3.png', c: 'img10.png', b: '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(strnatcasecmp(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
}

// 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/info/ini_get (Locutus dependency module)
function ini_get(varname: string): string {
  //  discuss at: https://locutus.io/php/ini_get/
  // original by: Brett Zamir (https://brett-zamir.me)
  //      note 1: The ini values must be set by ini_set or manually within an ini file
  //   example 1: ini_set('date.timezone', 'Asia/Hong_Kong')
  //   example 1: ini_get('date.timezone')
  //   returns 1: 'Asia/Hong_Kong'

  const runtime = ensurePhpRuntimeState()
  const entry = runtime.ini[varname]

  if (entry && entry.local_value !== undefined) {
    if (entry.local_value === null) {
      return ''
    }
    return String(entry.local_value)
  }

  return ''
}

// 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/strings/strnatcasecmp (Locutus dependency module)
function strnatcasecmp(a: string | number, b: string | number): number

function strnatcasecmp(...providedArgs: [a?: string | number, b?: string | number]): number | null {
  //       discuss at: https://locutus.io/php/strnatcasecmp/
  //  parity verified: PHP 8.3
  //      original by: Martin Pool
  // reimplemented by: Pierre-Luc Paour
  // reimplemented by: Kristof Coomans (SCK-CEN (Belgian Nucleair Research Centre))
  // reimplemented by: Brett Zamir (https://brett-zamir.me)
  //      bugfixed by: Kevin van Zonneveld (https://kvz.io)
  //         input by: Devan Penner-Woelk
  //      improved by: Kevin van Zonneveld (https://kvz.io)
  // reimplemented by: Rafał Kukawski
  //        example 1: strnatcasecmp(10, 1)
  //        returns 1: 1
  //        example 2: strnatcasecmp('1', '10')
  //        returns 2: -1

  if (providedArgs.length !== 2) {
    return null
  }

  const [a, b] = providedArgs
  return strnatcmp(_phpCastString(a).toLowerCase(), _phpCastString(b).toLowerCase())
}

// php/array/natcasesort (target function module)
function natcasesort<T extends string | number>(inputArr: Record<string, T>): boolean | Record<string, T> {
  //      discuss at: https://locutus.io/php/natcasesort/
  // 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
  //          note 1: We cannot use numbers as keys and have them be reordered since they
  //          note 1: adhere to numerical order in some implementations
  //       example 1: var $array1 = {a:'IMG0.png', b:'img12.png', c:'img10.png', d:'img2.png', e:'img1.png', f:'IMG3.png'}
  //       example 1: natcasesort($array1)
  //       example 1: var $result = $array1
  //       returns 1: {a: 'IMG0.png', e: 'img1.png', d: 'img2.png', f: 'IMG3.png', c: 'img10.png', b: 'img12.png'}

  const valArr: [string, T][] = []
  let k: string
  let i: number
  let sortByReference = false
  let populateArr: Record<string, T> = {}

  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(strnatcasecmp(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
}

// 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/info/ini_get (Locutus dependency module)
function ini_get(varname) {
  //  discuss at: https://locutus.io/php/ini_get/
  // original by: Brett Zamir (https://brett-zamir.me)
  //      note 1: The ini values must be set by ini_set or manually within an ini file
  //   example 1: ini_set('date.timezone', 'Asia/Hong_Kong')
  //   example 1: ini_get('date.timezone')
  //   returns 1: 'Asia/Hong_Kong'

  const runtime = ensurePhpRuntimeState()
  const entry = runtime.ini[varname]

  if (entry && entry.local_value !== undefined) {
    if (entry.local_value === null) {
      return ''
    }
    return String(entry.local_value)
  }

  return ''
}

// 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/strings/strnatcasecmp (Locutus dependency module)

function strnatcasecmp(...providedArgs) {
  //       discuss at: https://locutus.io/php/strnatcasecmp/
  //  parity verified: PHP 8.3
  //      original by: Martin Pool
  // reimplemented by: Pierre-Luc Paour
  // reimplemented by: Kristof Coomans (SCK-CEN (Belgian Nucleair Research Centre))
  // reimplemented by: Brett Zamir (https://brett-zamir.me)
  //      bugfixed by: Kevin van Zonneveld (https://kvz.io)
  //         input by: Devan Penner-Woelk
  //      improved by: Kevin van Zonneveld (https://kvz.io)
  // reimplemented by: Rafał Kukawski
  //        example 1: strnatcasecmp(10, 1)
  //        returns 1: 1
  //        example 2: strnatcasecmp('1', '10')
  //        returns 2: -1

  if (providedArgs.length !== 2) {
    return null
  }

  const [a, b] = providedArgs
  return strnatcmp(_phpCastString(a).toLowerCase(), _phpCastString(b).toLowerCase())
}

// php/array/natcasesort (target function module)
function natcasesort(inputArr) {
  //      discuss at: https://locutus.io/php/natcasesort/
  // 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
  //          note 1: We cannot use numbers as keys and have them be reordered since they
  //          note 1: adhere to numerical order in some implementations
  //       example 1: var $array1 = {a:'IMG0.png', b:'img12.png', c:'img10.png', d:'img2.png', e:'img1.png', f:'IMG3.png'}
  //       example 1: natcasesort($array1)
  //       example 1: var $result = $array1
  //       returns 1: {a: 'IMG0.png', e: 'img1.png', d: 'img2.png', f: 'IMG3.png', c: 'img10.png', b: '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(strnatcasecmp(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
}

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