PHP's array_diff_ukey in TypeScript

How to use

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

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

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 = {blue: 1, red: 2, green: 3, purple: 4} var $array2 = {green: 5, blue: 6, yellow: 7, cyan: 8} array_diff_ukey($array1, $array2, function (key1, key2){ return (key1 === key2 ? 0 : (key1 > key2 ? 1 : -1)); })	{red: 2, purple: 4}

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.

Dependencies

This function uses the following Locutus functions:

• _callbackResolver (php/_helpers)
• _phpTypes (php/_helpers)

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

import { resolveNumericComparator } from '../_helpers/_callbackResolver.ts'
import {
  entriesOfPhpAssoc,
  isPhpCallableDescriptor,
  type PhpAssoc,
  type PhpKeyComparatorDescriptor,
  toPhpArrayObject,
} from '../_helpers/_phpTypes.ts'

type DiffArray<T> = PhpAssoc<T> | T[]

export function array_diff_ukey<T>(
  arr1: PhpAssoc<T>,
  ...arraysAndCallback: [arr2: DiffArray<T>, ...rest: Array<DiffArray<T>>, callback: PhpKeyComparatorDescriptor]
): PhpAssoc<T> {
  //  discuss at: https://locutus.io/php/array_diff_ukey/
  // original by: Brett Zamir (https://brett-zamir.me)
  //   example 1: var $array1 = {blue: 1, red: 2, green: 3, purple: 4}
  //   example 1: var $array2 = {green: 5, blue: 6, yellow: 7, cyan: 8}
  //   example 1: array_diff_ukey($array1, $array2, function (key1, key2){ return (key1 === key2 ? 0 : (key1 > key2 ? 1 : -1)); })
  //   returns 1: {red: 2, purple: 4}

  const retArr: PhpAssoc<T> = {}
  const callback = arraysAndCallback.at(-1)
  if (typeof callback === 'undefined' || !isPhpCallableDescriptor<[string, string]>(callback)) {
    throw new Error('array_diff_ukey(): Invalid callback')
  }
  const arrays = arraysAndCallback.slice(0, -1).map((value) => toPhpArrayObject<T>(value))
  const keyComparator = resolveNumericComparator<string, string>(callback, 'array_diff_ukey(): Invalid callback')

  arr1keys: for (const [k1, arr1Value] of entriesOfPhpAssoc(arr1)) {
    for (const arr of arrays) {
      for (const [k] of entriesOfPhpAssoc(arr)) {
        if (keyComparator(k, k1) === 0) {
          // If it reaches here, it was found in at least one array, so try next value
          continue arr1keys
        }
      }
    }
    retArr[k1] = arr1Value
  }

  return retArr
}

import { resolveNumericComparator } from '../_helpers/_callbackResolver.ts'
import { entriesOfPhpAssoc, isPhpCallableDescriptor, toPhpArrayObject } from '../_helpers/_phpTypes.ts'

export function array_diff_ukey(arr1, ...arraysAndCallback) {
  //  discuss at: https://locutus.io/php/array_diff_ukey/
  // original by: Brett Zamir (https://brett-zamir.me)
  //   example 1: var $array1 = {blue: 1, red: 2, green: 3, purple: 4}
  //   example 1: var $array2 = {green: 5, blue: 6, yellow: 7, cyan: 8}
  //   example 1: array_diff_ukey($array1, $array2, function (key1, key2){ return (key1 === key2 ? 0 : (key1 > key2 ? 1 : -1)); })
  //   returns 1: {red: 2, purple: 4}

  const retArr = {}
  const callback = arraysAndCallback.at(-1)
  if (typeof callback === 'undefined' || !isPhpCallableDescriptor(callback)) {
    throw new Error('array_diff_ukey(): Invalid callback')
  }
  const arrays = arraysAndCallback.slice(0, -1).map((value) => toPhpArrayObject(value))
  const keyComparator = resolveNumericComparator(callback, 'array_diff_ukey(): Invalid callback')

  arr1keys: for (const [k1, arr1Value] of entriesOfPhpAssoc(arr1)) {
    for (const arr of arrays) {
      for (const [k] of entriesOfPhpAssoc(arr)) {
        if (keyComparator(k, k1) === 0) {
          // If it reaches here, it was found in at least one array, so try next value
          continue arr1keys
        }
      }
    }
    retArr[k1] = arr1Value
  }

  return retArr
}

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

type PhpInput = {} | PhpNullish

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>

const entriesOfPhpAssoc = <T>(value: PhpAssoc<T>): Array<[string, T]> => {
  return Object.entries(value)
}

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 isObjectLike(value: PhpInput): value is PhpArrayLike<PhpInput> {
  return typeof value === 'object' && value !== null
}

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

function isPhpCallableDescriptor<TArgs extends PhpCallableArgs = PhpCallableArgs, TResult = PhpInput>(
  value: PhpInput,
): value is PhpCallableDescriptor<TArgs, TResult> {
  if (typeof value === 'string') {
    return true
  }

  if (isPhpCallable<TArgs, TResult>(value)) {
    return true
  }

  if (!Array.isArray(value) || value.length < 2) {
    return false
  }

  const callableDescriptor = value[1]
  return typeof callableDescriptor === 'string' || isPhpCallable<TArgs, TResult>(callableDescriptor)
}

function isPhpArrayObject<T = PhpInput>(value: PhpInput): value is PhpAssoc<T> {
  return isObjectLike(value)
}

function toPhpArrayObject<T = PhpInput>(value: PhpInput): PhpAssoc<T> {
  if (isPhpArrayObject<T>(value)) {
    return value
  }

  return {}
}

// php/_helpers/_phpRuntimeState (Locutus helper dependency)
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
}

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

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

function resolveNumericComparator<
  TLeft extends CallbackValue = CallbackValue,
  TRight extends CallbackValue = CallbackValue,
>(
  callback: PhpCallableDescriptor<[TLeft, TRight], NumericLike>,
  invalidMessage: string,
): (left: TLeft, right: TRight) => number {
  const resolved = resolvePhpCallable<[TLeft, TRight], NumericLike>(callback, { invalidMessage })

  return (left: TLeft, right: TRight): number => Number(resolved.fn.apply(resolved.scope, [left, right]))
}

// php/array/array_diff_ukey (target function module)
type DiffArray<T> = PhpAssoc<T> | T[]

function array_diff_ukey<T>(
  arr1: PhpAssoc<T>,
  ...arraysAndCallback: [arr2: DiffArray<T>, ...rest: Array<DiffArray<T>>, callback: PhpKeyComparatorDescriptor]
): PhpAssoc<T> {
  //  discuss at: https://locutus.io/php/array_diff_ukey/
  // original by: Brett Zamir (https://brett-zamir.me)
  //   example 1: var $array1 = {blue: 1, red: 2, green: 3, purple: 4}
  //   example 1: var $array2 = {green: 5, blue: 6, yellow: 7, cyan: 8}
  //   example 1: array_diff_ukey($array1, $array2, function (key1, key2){ return (key1 === key2 ? 0 : (key1 > key2 ? 1 : -1)); })
  //   returns 1: {red: 2, purple: 4}

  const retArr: PhpAssoc<T> = {}
  const callback = arraysAndCallback.at(-1)
  if (typeof callback === 'undefined' || !isPhpCallableDescriptor<[string, string]>(callback)) {
    throw new Error('array_diff_ukey(): Invalid callback')
  }
  const arrays = arraysAndCallback.slice(0, -1).map((value) => toPhpArrayObject<T>(value))
  const keyComparator = resolveNumericComparator<string, string>(callback, 'array_diff_ukey(): Invalid callback')

  arr1keys: for (const [k1, arr1Value] of entriesOfPhpAssoc(arr1)) {
    for (const arr of arrays) {
      for (const [k] of entriesOfPhpAssoc(arr)) {
        if (keyComparator(k, k1) === 0) {
          // If it reaches here, it was found in at least one array, so try next value
          continue arr1keys
        }
      }
    }
    retArr[k1] = arr1Value
  }

  return retArr
}

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

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

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

function isPhpCallableDescriptor(value) {
  if (typeof value === 'string') {
    return true
  }

  if (isPhpCallable(value)) {
    return true
  }

  if (!Array.isArray(value) || value.length < 2) {
    return false
  }

  const callableDescriptor = value[1]
  return typeof callableDescriptor === 'string' || isPhpCallable(callableDescriptor)
}

function toPhpArrayObject(value) {
  if (isPhpArrayObject(value)) {
    return value
  }

  return {}
}

const isPhpArrayObject = isObjectLike

// php/_helpers/_phpRuntimeState (Locutus helper dependency)
const globalContext =
  typeof window === 'object' && window !== null ? window : typeof global === 'object' && global !== null ? global : {}

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

function resolveNumericComparator(callback, invalidMessage) {
  const resolved = resolvePhpCallable(callback, { invalidMessage })

  return (left, right) => Number(resolved.fn.apply(resolved.scope, [left, right]))
}

// php/array/array_diff_ukey (target function module)
function array_diff_ukey(arr1, ...arraysAndCallback) {
  //  discuss at: https://locutus.io/php/array_diff_ukey/
  // original by: Brett Zamir (https://brett-zamir.me)
  //   example 1: var $array1 = {blue: 1, red: 2, green: 3, purple: 4}
  //   example 1: var $array2 = {green: 5, blue: 6, yellow: 7, cyan: 8}
  //   example 1: array_diff_ukey($array1, $array2, function (key1, key2){ return (key1 === key2 ? 0 : (key1 > key2 ? 1 : -1)); })
  //   returns 1: {red: 2, purple: 4}

  const retArr = {}
  const callback = arraysAndCallback.at(-1)
  if (typeof callback === 'undefined' || !isPhpCallableDescriptor(callback)) {
    throw new Error('array_diff_ukey(): Invalid callback')
  }
  const arrays = arraysAndCallback.slice(0, -1).map((value) => toPhpArrayObject(value))
  const keyComparator = resolveNumericComparator(callback, 'array_diff_ukey(): Invalid callback')

  arr1keys: for (const [k1, arr1Value] of Object.entries(arr1)) {
    for (const arr of arrays) {
      for (const [k] of Object.entries(arr)) {
        if (keyComparator(k, k1) === 0) {
          // If it reaches here, it was found in at least one array, so try next value
          continue arr1keys
        }
      }
    }
    retArr[k1] = arr1Value
  }

  return retArr
}

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