PHP's array_walk in TypeScript

How to use

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

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

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	`array_walk ([3, 4], function () {}, 'userdata')`	`true`
2	`array_walk ('mystring', function () {})`	`false`
3	`array_walk ({"title":"my title"}, function () {})`	`true`

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

Only works with user-defined functions, not built-in functions like void()

Dependencies

This function uses the following Locutus functions:

_phpTypes (php/_helpers)

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

import { type PhpAssoc, type PhpRuntimeValue, toPhpArrayObject } from '../_helpers/_phpTypes.ts'

type ArrayWalkCallback<TKey extends number | string, TValue, TUserdata> = (
  value: TValue,
  key: TKey,
  userdata?: TUserdata,
) => void
type ArrayWalkInput = PhpRuntimeValue

export function array_walk<
  TValue extends ArrayWalkInput = ArrayWalkInput,
  TUserdata extends ArrayWalkInput = ArrayWalkInput,
>(array: TValue[], funcname: ArrayWalkCallback<number, TValue, TUserdata>, userdata?: TUserdata): boolean

export function array_walk<
  TValue extends ArrayWalkInput = ArrayWalkInput,
  TUserdata extends ArrayWalkInput = ArrayWalkInput,
>(array: PhpAssoc<TValue>, funcname: ArrayWalkCallback<string, TValue, TUserdata>, userdata?: TUserdata): boolean

export function array_walk<
  TValue extends ArrayWalkInput = ArrayWalkInput,
  TUserdata extends ArrayWalkInput = ArrayWalkInput,
>(
  array: TValue[] | PhpAssoc<TValue>,
  funcname: ArrayWalkCallback<number, TValue, TUserdata> | ArrayWalkCallback<string, TValue, TUserdata>,
  userdata?: TUserdata,
): boolean {
  //  discuss at: https://locutus.io/php/array_walk/
  // original by: Johnny Mast (https://www.phpvrouwen.nl)
  // bugfixed by: David
  // improved by: Brett Zamir (https://brett-zamir.me)
  //      note 1: Only works with user-defined functions, not built-in functions like void()
  //   example 1: array_walk ([3, 4], function () {}, 'userdata')
  //   returns 1: true
  //   example 2: array_walk ('mystring', function () {})
  //   returns 2: false
  //   example 3: array_walk ({"title":"my title"}, function () {})
  //   returns 3: true

  if (!array || typeof array !== 'object') {
    return false
  }

  try {
    const hasUserdata = typeof userdata !== 'undefined'
    const callback = funcname
    if (Array.isArray(array)) {
      for (const [index, value] of array.entries()) {
        if (hasUserdata) {
          Reflect.apply(callback, undefined, [value, index, userdata])
        } else {
          Reflect.apply(callback, undefined, [value, index])
        }
      }
      return true
    }

    const target = toPhpArrayObject<TValue>(array)
    for (const [key, value] of Object.entries(target)) {
      if (hasUserdata) {
        Reflect.apply(callback, undefined, [value, key, userdata])
      } else {
        Reflect.apply(callback, undefined, [value, key])
      }
    }
  } catch (_e) {
    return false
  }

  return true
}

import { toPhpArrayObject } from '../_helpers/_phpTypes.ts'

export function array_walk(array, funcname, userdata) {
  //  discuss at: https://locutus.io/php/array_walk/
  // original by: Johnny Mast (https://www.phpvrouwen.nl)
  // bugfixed by: David
  // improved by: Brett Zamir (https://brett-zamir.me)
  //      note 1: Only works with user-defined functions, not built-in functions like void()
  //   example 1: array_walk ([3, 4], function () {}, 'userdata')
  //   returns 1: true
  //   example 2: array_walk ('mystring', function () {})
  //   returns 2: false
  //   example 3: array_walk ({"title":"my title"}, function () {})
  //   returns 3: true

  if (!array || typeof array !== 'object') {
    return false
  }

  try {
    const hasUserdata = typeof userdata !== 'undefined'
    const callback = funcname
    if (Array.isArray(array)) {
      for (const [index, value] of array.entries()) {
        if (hasUserdata) {
          Reflect.apply(callback, undefined, [value, index, userdata])
        } else {
          Reflect.apply(callback, undefined, [value, index])
        }
      }
      return true
    }

    const target = toPhpArrayObject(array)
    for (const [key, value] of Object.entries(target)) {
      if (hasUserdata) {
        Reflect.apply(callback, undefined, [value, key, userdata])
      } else {
        Reflect.apply(callback, undefined, [value, key])
      }
    }
  } catch (_e) {
    return false
  }

  return true
}

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

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/array/array_walk (target function module)
type ArrayWalkCallback<TKey extends number | string, TValue, TUserdata> = (
  value: TValue,
  key: TKey,
  userdata?: TUserdata,
) => void

type ArrayWalkInput = PhpRuntimeValue

function array_walk<
  TValue extends ArrayWalkInput = ArrayWalkInput,
  TUserdata extends ArrayWalkInput = ArrayWalkInput,
>(array: TValue[], funcname: ArrayWalkCallback<number, TValue, TUserdata>, userdata?: TUserdata): boolean

function array_walk<
  TValue extends ArrayWalkInput = ArrayWalkInput,
  TUserdata extends ArrayWalkInput = ArrayWalkInput,
>(array: PhpAssoc<TValue>, funcname: ArrayWalkCallback<string, TValue, TUserdata>, userdata?: TUserdata): boolean

function array_walk<
  TValue extends ArrayWalkInput = ArrayWalkInput,
  TUserdata extends ArrayWalkInput = ArrayWalkInput,
>(
  array: TValue[] | PhpAssoc<TValue>,
  funcname: ArrayWalkCallback<number, TValue, TUserdata> | ArrayWalkCallback<string, TValue, TUserdata>,
  userdata?: TUserdata,
): boolean {
  //  discuss at: https://locutus.io/php/array_walk/
  // original by: Johnny Mast (https://www.phpvrouwen.nl)
  // bugfixed by: David
  // improved by: Brett Zamir (https://brett-zamir.me)
  //      note 1: Only works with user-defined functions, not built-in functions like void()
  //   example 1: array_walk ([3, 4], function () {}, 'userdata')
  //   returns 1: true
  //   example 2: array_walk ('mystring', function () {})
  //   returns 2: false
  //   example 3: array_walk ({"title":"my title"}, function () {})
  //   returns 3: true

  if (!array || typeof array !== 'object') {
    return false
  }

  try {
    const hasUserdata = typeof userdata !== 'undefined'
    const callback = funcname
    if (Array.isArray(array)) {
      for (const [index, value] of array.entries()) {
        if (hasUserdata) {
          Reflect.apply(callback, undefined, [value, index, userdata])
        } else {
          Reflect.apply(callback, undefined, [value, index])
        }
      }
      return true
    }

    const target = toPhpArrayObject<TValue>(array)
    for (const [key, value] of Object.entries(target)) {
      if (hasUserdata) {
        Reflect.apply(callback, undefined, [value, key, userdata])
      } else {
        Reflect.apply(callback, undefined, [value, key])
      }
    }
  } catch (_e) {
    return false
  }

  return true
}

// php/_helpers/_phpTypes (Locutus helper dependency)
function isPhpArrayObject(value) {
  return typeof value === 'object' && value !== null
}

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

  return {}
}

// php/array/array_walk (target function module)

function array_walk(array, funcname, userdata) {
  //  discuss at: https://locutus.io/php/array_walk/
  // original by: Johnny Mast (https://www.phpvrouwen.nl)
  // bugfixed by: David
  // improved by: Brett Zamir (https://brett-zamir.me)
  //      note 1: Only works with user-defined functions, not built-in functions like void()
  //   example 1: array_walk ([3, 4], function () {}, 'userdata')
  //   returns 1: true
  //   example 2: array_walk ('mystring', function () {})
  //   returns 2: false
  //   example 3: array_walk ({"title":"my title"}, function () {})
  //   returns 3: true

  if (!array || typeof array !== 'object') {
    return false
  }

  try {
    const hasUserdata = typeof userdata !== 'undefined'
    const callback = funcname
    if (Array.isArray(array)) {
      for (const [index, value] of array.entries()) {
        if (hasUserdata) {
          Reflect.apply(callback, undefined, [value, index, userdata])
        } else {
          Reflect.apply(callback, undefined, [value, index])
        }
      }
      return true
    }

    const target = toPhpArrayObject(array)
    for (const [key, value] of Object.entries(target)) {
      if (hasUserdata) {
        Reflect.apply(callback, undefined, [value, key, userdata])
      } else {
        Reflect.apply(callback, undefined, [value, key])
      }
    }
  } catch (_e) {
    return false
  }

  return true
}

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