PHP's array_push in TypeScript

How to use

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

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

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_push(['kevin','van'], 'zonneveld')	3

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

• Note also that IE retains information about property position even after being supposedly deleted, so if you delete properties and then add back properties with the same keys (including numeric) that had been deleted, the order will be as before; thus, this function is not really recommended with associative arrays (objects) in IE environments

Dependencies

This function uses the following Locutus functions:

• _phpTypes (php/_helpers)

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

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

export function array_push<TValue>(inputArr: PhpArrayLike<TValue>, ...values: TValue[]): number {
  //  discuss at: https://locutus.io/php/array_push/
  // original by: Kevin van Zonneveld (https://kvz.io)
  // improved by: Brett Zamir (https://brett-zamir.me)
  //      note 1: Note also that IE retains information about property position even
  //      note 1: after being supposedly deleted, so if you delete properties and then
  //      note 1: add back properties with the same keys (including numeric) that had
  //      note 1: been deleted, the order will be as before; thus, this function is not
  //      note 1: really recommended with associative arrays (objects) in IE environments
  //   example 1: array_push(['kevin','van'], 'zonneveld')
  //   returns 1: 3

  const allDigits = /^\d+$/
  let size = 0
  let highestIdx = 0
  let len = 0

  if (Array.isArray(inputArr)) {
    for (const value of values) {
      inputArr.push(value)
    }
    return inputArr.length
  }

  // Associative (object)
  const target = toPhpArrayObject<TValue>(inputArr)
  for (const pr of Object.keys(target)) {
    ++len
    if (allDigits.test(pr)) {
      size = parseInt(pr, 10)
      highestIdx = size > highestIdx ? size : highestIdx
    }
  }
  for (const value of values) {
    target[++highestIdx] = value
  }

  return len + values.length
}

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

export function array_push(inputArr, ...values) {
  //  discuss at: https://locutus.io/php/array_push/
  // original by: Kevin van Zonneveld (https://kvz.io)
  // improved by: Brett Zamir (https://brett-zamir.me)
  //      note 1: Note also that IE retains information about property position even
  //      note 1: after being supposedly deleted, so if you delete properties and then
  //      note 1: add back properties with the same keys (including numeric) that had
  //      note 1: been deleted, the order will be as before; thus, this function is not
  //      note 1: really recommended with associative arrays (objects) in IE environments
  //   example 1: array_push(['kevin','van'], 'zonneveld')
  //   returns 1: 3

  const allDigits = /^\d+$/
  let size = 0
  let highestIdx = 0
  let len = 0

  if (Array.isArray(inputArr)) {
    for (const value of values) {
      inputArr.push(value)
    }
    return inputArr.length
  }

  // Associative (object)
  const target = toPhpArrayObject(inputArr)
  for (const pr of Object.keys(target)) {
    ++len
    if (allDigits.test(pr)) {
      size = parseInt(pr, 10)
      highestIdx = size > highestIdx ? size : highestIdx
    }
  }
  for (const value of values) {
    target[++highestIdx] = value
  }

  return len + values.length
}

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

type PhpInput = {} | PhpNullish

type PhpList<T = PhpInput> = T[]

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

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

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_push (target function module)
function array_push<TValue>(inputArr: PhpArrayLike<TValue>, ...values: TValue[]): number {
  //  discuss at: https://locutus.io/php/array_push/
  // original by: Kevin van Zonneveld (https://kvz.io)
  // improved by: Brett Zamir (https://brett-zamir.me)
  //      note 1: Note also that IE retains information about property position even
  //      note 1: after being supposedly deleted, so if you delete properties and then
  //      note 1: add back properties with the same keys (including numeric) that had
  //      note 1: been deleted, the order will be as before; thus, this function is not
  //      note 1: really recommended with associative arrays (objects) in IE environments
  //   example 1: array_push(['kevin','van'], 'zonneveld')
  //   returns 1: 3

  const allDigits = /^\d+$/
  let size = 0
  let highestIdx = 0
  let len = 0

  if (Array.isArray(inputArr)) {
    for (const value of values) {
      inputArr.push(value)
    }
    return inputArr.length
  }

  // Associative (object)
  const target = toPhpArrayObject<TValue>(inputArr)
  for (const pr of Object.keys(target)) {
    ++len
    if (allDigits.test(pr)) {
      size = parseInt(pr, 10)
      highestIdx = size > highestIdx ? size : highestIdx
    }
  }
  for (const value of values) {
    target[++highestIdx] = value
  }

  return len + values.length
}

// 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_push (target function module)
function array_push(inputArr, ...values) {
  //  discuss at: https://locutus.io/php/array_push/
  // original by: Kevin van Zonneveld (https://kvz.io)
  // improved by: Brett Zamir (https://brett-zamir.me)
  //      note 1: Note also that IE retains information about property position even
  //      note 1: after being supposedly deleted, so if you delete properties and then
  //      note 1: add back properties with the same keys (including numeric) that had
  //      note 1: been deleted, the order will be as before; thus, this function is not
  //      note 1: really recommended with associative arrays (objects) in IE environments
  //   example 1: array_push(['kevin','van'], 'zonneveld')
  //   returns 1: 3

  const allDigits = /^\d+$/
  let size = 0
  let highestIdx = 0
  let len = 0

  if (Array.isArray(inputArr)) {
    for (const value of values) {
      inputArr.push(value)
    }
    return inputArr.length
  }

  // Associative (object)
  const target = toPhpArrayObject(inputArr)
  for (const pr of Object.keys(target)) {
    ++len
    if (allDigits.test(pr)) {
      size = parseInt(pr, 10)
      highestIdx = size > highestIdx ? size : highestIdx
    }
  }
  for (const value of values) {
    target[++highestIdx] = value
  }

  return len + values.length
}

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