PHP's var_export in TypeScript

How to use

Install via yarn add locutus and import: import { var_export } from 'locutus/php/var/var_export'.

Or with CommonJS: const { var_export } = require('locutus/php/var/var_export')

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_export(null)	null
2	var_export({0: 'Kevin', 1: 'van', 2: 'Zonneveld'}, true)	"array (\n 0 => 'Kevin',\n 1 => 'van',\n 2 => 'Zonneveld',\n)"
3	var data = 'Kevin' var_export(data, true)	"'Kevin'"
4	var_export({0: 'Kevin', 1: 'van', 'lastName': 'Zonneveld'}, true)	"array (\n 0 => 'Kevin',\n 1 => 'van',\n 'lastName' => 'Zonneveld',\n)"
5	var_export([], true)	"array (\n)"
6	var_export({ test: [ 'a', 'b' ] }, true)	"array (\n 'test' => \n array (\n 0 => 'a',\n 1 => 'b',\n ),\n)"

Dependencies

This function uses the following Locutus functions:

• _phpRuntimeState (php/_helpers)
• _phpTypes (php/_helpers)
• echo (php/strings)

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

import { getPhpObjectEntry } from '../_helpers/_phpRuntimeState.ts'
import { type PhpRuntimeValue, toPhpArrayObject } from '../_helpers/_phpTypes.ts'
import { echo } from '../strings/echo.ts'

type VarExportInput = PhpRuntimeValue

type VarExportType =
  | 'resource'
  | 'function'
  | 'null'
  | 'array'
  | 'object'
  | 'string'
  | 'number'
  | 'boolean'
  | 'undefined'
type VarExportResult = string | number | boolean | null

export function var_export(mixedExpression: VarExportInput, boolReturn: true, idtLevel?: number): VarExportResult
export function var_export(mixedExpression: VarExportInput, boolReturn?: false | undefined, idtLevel?: number): null
export function var_export(
  mixedExpression: VarExportInput,
  boolReturn?: boolean,
  idtLevel?: number,
): VarExportResult | null
export function var_export(
  mixedExpression: VarExportInput,
  boolReturn?: boolean,
  idtLevel = 2,
): VarExportResult | null {
  //  discuss at: https://locutus.io/php/var_export/
  // original by: Philip Peterson
  // improved by: johnrembo
  // improved by: Brett Zamir (https://brett-zamir.me)
  //    input by: Brian Tafoya (https://www.premasolutions.com/)
  //    input by: Hans Henrik (https://hanshenrik.tk/)
  // bugfixed by: Brett Zamir (https://brett-zamir.me)
  // bugfixed by: Brett Zamir (https://brett-zamir.me)
  // bugfixed by: simivar (https://github.com/simivar)
  // bugfixed by: simivar (https://github.com/simivar)
  // bugfixed by: simivar (https://github.com/simivar)
  //   example 1: var_export(null)
  //   returns 1: null
  //   example 2: var_export({0: 'Kevin', 1: 'van', 2: 'Zonneveld'}, true)
  //   returns 2: "array (\n  0 => 'Kevin',\n  1 => 'van',\n  2 => 'Zonneveld',\n)"
  //   example 3: var data = 'Kevin'
  //   example 3: var_export(data, true)
  //   returns 3: "'Kevin'"
  //   example 4: var_export({0: 'Kevin', 1: 'van', 'lastName': 'Zonneveld'}, true)
  //   returns 4: "array (\n  0 => 'Kevin',\n  1 => 'van',\n  'lastName' => 'Zonneveld',\n)"
  //   example 5: var_export([], true)
  //   returns 5: "array (\n)"
  //   example 6: var_export({ test: [ 'a', 'b' ] }, true)
  //   returns 6: "array (\n  'test' => \n  array (\n    0 => 'a',\n    1 => 'b',\n  ),\n)"

  let retstr: VarExportResult = ''
  let iret = ''
  let value = ''
  let cnt = 0
  const x: string[] = []
  // We use the last argument (not part of PHP) to pass in
  // our indentation level
  let innerIndent = ''
  let outerIndent = ''
  const getFuncName = function (fn: { toString: () => string }): string {
    const name = /\W*function\s+([\w$]+)\s*\(/.exec(fn.toString())
    if (!name) {
      return '(Anonymous)'
    }
    return name[1] ?? '(Anonymous)'
  }

  const _isNormalInteger = function (input: string): boolean {
    const number = Math.floor(Number(input))
    return number !== Infinity && String(number) === input && number >= 0
  }

  const _makeIndent = function (indentLevel: number): string {
    return new Array(Math.max(indentLevel, 0) + 1).join(' ')
  }
  const __getType = function (inp: VarExportInput): VarExportType | null {
    let i = 0
    let match: RegExpMatchArray | null = null
    let cons = ''
    const types: Array<'boolean' | 'number' | 'string' | 'array'> = ['boolean', 'number', 'string', 'array']
    const jsType = typeof inp
    let type: VarExportType | null =
      jsType === 'boolean' ||
      jsType === 'number' ||
      jsType === 'string' ||
      jsType === 'function' ||
      jsType === 'undefined' ||
      jsType === 'object'
        ? jsType
        : null
    if (type === 'object' && typeof inp === 'object' && inp !== null) {
      const constructorValue = getPhpObjectEntry(inp, 'constructor')
      if (typeof constructorValue === 'function' && getFuncName(constructorValue) === 'LOCUTUS_Resource') {
        return 'resource'
      }
    }
    if (type === 'function') {
      return 'function'
    }
    if (type === 'object' && !inp) {
      // Should this be just null?
      return 'null'
    }
    if (type === 'object' && typeof inp === 'object' && inp !== null) {
      const constructorValue = getPhpObjectEntry(inp, 'constructor')
      if (typeof constructorValue !== 'function') {
        return 'object'
      }
      cons = constructorValue.toString()
      match = cons.match(/(\w+)\(/)
      if (match) {
        cons = (match[1] ?? '').toLowerCase()
      }
      for (i = 0; i < types.length; i++) {
        const knownType = types[i]
        if (knownType && cons === knownType) {
          type = knownType
          break
        }
      }
    }
    return type
  }
  const type = __getType(mixedExpression)

  if (type === null) {
    retstr = 'NULL'
  } else if (type === 'array' || type === 'object') {
    const source = toPhpArrayObject<VarExportInput>(mixedExpression)
    outerIndent = _makeIndent(idtLevel - 2)
    innerIndent = _makeIndent(idtLevel)
    for (const [key, entry] of Object.entries(source)) {
      value = ' '
      const subtype = __getType(entry)
      if (subtype === 'array' || subtype === 'object' || subtype === 'function') {
        value = ' \n'
      }
      value += String(var_export(entry, true, idtLevel + 2))
      const mappedKey = _isNormalInteger(key) ? key : `'${key}'`
      x[cnt++] = innerIndent + mappedKey + ' =>' + value
    }
    if (x.length > 0) {
      iret = x.join(',\n') + ',\n'
    }
    retstr = outerIndent + 'array (\n' + iret + outerIndent + ')'
  } else if (type === 'function') {
    // PHP deprecated create_function() in 7.2 and removed it in 8.0.
    // On our PHP 8.3 parity target, closures export as \Closure::__set_state(array()).
    outerIndent = _makeIndent(idtLevel - 2)
    retstr = outerIndent + '\\Closure::__set_state(array(\n' + outerIndent + '))'
  } else if (type === 'resource') {
    // Resources treated as null for var_export
    retstr = 'NULL'
  } else {
    if (typeof mixedExpression === 'string') {
      retstr = "'" + mixedExpression.replace(/([\\'])/g, '\\$1').replace(/\0/g, '\\0') + "'"
    } else if (mixedExpression === null) {
      retstr = null
    } else if (typeof mixedExpression === 'number') {
      retstr = Number(mixedExpression)
    } else if (typeof mixedExpression === 'boolean') {
      retstr = Boolean(mixedExpression)
    } else {
      retstr = String(mixedExpression)
    }
  }

  if (!boolReturn) {
    echo(retstr)
    return null
  }

  return retstr
}

import { getPhpObjectEntry } from '../_helpers/_phpRuntimeState.ts'
import { toPhpArrayObject } from '../_helpers/_phpTypes.ts'
import { echo } from '../strings/echo.ts'
export function var_export(mixedExpression, boolReturn, idtLevel = 2) {
  //  discuss at: https://locutus.io/php/var_export/
  // original by: Philip Peterson
  // improved by: johnrembo
  // improved by: Brett Zamir (https://brett-zamir.me)
  //    input by: Brian Tafoya (https://www.premasolutions.com/)
  //    input by: Hans Henrik (https://hanshenrik.tk/)
  // bugfixed by: Brett Zamir (https://brett-zamir.me)
  // bugfixed by: Brett Zamir (https://brett-zamir.me)
  // bugfixed by: simivar (https://github.com/simivar)
  // bugfixed by: simivar (https://github.com/simivar)
  // bugfixed by: simivar (https://github.com/simivar)
  //   example 1: var_export(null)
  //   returns 1: null
  //   example 2: var_export({0: 'Kevin', 1: 'van', 2: 'Zonneveld'}, true)
  //   returns 2: "array (\n  0 => 'Kevin',\n  1 => 'van',\n  2 => 'Zonneveld',\n)"
  //   example 3: var data = 'Kevin'
  //   example 3: var_export(data, true)
  //   returns 3: "'Kevin'"
  //   example 4: var_export({0: 'Kevin', 1: 'van', 'lastName': 'Zonneveld'}, true)
  //   returns 4: "array (\n  0 => 'Kevin',\n  1 => 'van',\n  'lastName' => 'Zonneveld',\n)"
  //   example 5: var_export([], true)
  //   returns 5: "array (\n)"
  //   example 6: var_export({ test: [ 'a', 'b' ] }, true)
  //   returns 6: "array (\n  'test' => \n  array (\n    0 => 'a',\n    1 => 'b',\n  ),\n)"

  let retstr = ''
  let iret = ''
  let value = ''
  let cnt = 0
  const x = []
  // We use the last argument (not part of PHP) to pass in
  // our indentation level
  let innerIndent = ''
  let outerIndent = ''
  const getFuncName = function (fn) {
    const name = /\W*function\s+([\w$]+)\s*\(/.exec(fn.toString())
    if (!name) {
      return '(Anonymous)'
    }
    return name[1] ?? '(Anonymous)'
  }

  const _isNormalInteger = function (input) {
    const number = Math.floor(Number(input))
    return number !== Infinity && String(number) === input && number >= 0
  }

  const _makeIndent = function (indentLevel) {
    return new Array(Math.max(indentLevel, 0) + 1).join(' ')
  }
  const __getType = function (inp) {
    let i = 0
    let match = null
    let cons = ''
    const types = ['boolean', 'number', 'string', 'array']
    const jsType = typeof inp
    let type =
      jsType === 'boolean' ||
      jsType === 'number' ||
      jsType === 'string' ||
      jsType === 'function' ||
      jsType === 'undefined' ||
      jsType === 'object'
        ? jsType
        : null
    if (type === 'object' && typeof inp === 'object' && inp !== null) {
      const constructorValue = getPhpObjectEntry(inp, 'constructor')
      if (typeof constructorValue === 'function' && getFuncName(constructorValue) === 'LOCUTUS_Resource') {
        return 'resource'
      }
    }
    if (type === 'function') {
      return 'function'
    }
    if (type === 'object' && !inp) {
      // Should this be just null?
      return 'null'
    }
    if (type === 'object' && typeof inp === 'object' && inp !== null) {
      const constructorValue = getPhpObjectEntry(inp, 'constructor')
      if (typeof constructorValue !== 'function') {
        return 'object'
      }
      cons = constructorValue.toString()
      match = cons.match(/(\w+)\(/)
      if (match) {
        cons = (match[1] ?? '').toLowerCase()
      }
      for (i = 0; i < types.length; i++) {
        const knownType = types[i]
        if (knownType && cons === knownType) {
          type = knownType
          break
        }
      }
    }
    return type
  }
  const type = __getType(mixedExpression)

  if (type === null) {
    retstr = 'NULL'
  } else if (type === 'array' || type === 'object') {
    const source = toPhpArrayObject(mixedExpression)
    outerIndent = _makeIndent(idtLevel - 2)
    innerIndent = _makeIndent(idtLevel)
    for (const [key, entry] of Object.entries(source)) {
      value = ' '
      const subtype = __getType(entry)
      if (subtype === 'array' || subtype === 'object' || subtype === 'function') {
        value = ' \n'
      }
      value += String(var_export(entry, true, idtLevel + 2))
      const mappedKey = _isNormalInteger(key) ? key : `'${key}'`
      x[cnt++] = innerIndent + mappedKey + ' =>' + value
    }
    if (x.length > 0) {
      iret = x.join(',\n') + ',\n'
    }
    retstr = outerIndent + 'array (\n' + iret + outerIndent + ')'
  } else if (type === 'function') {
    // PHP deprecated create_function() in 7.2 and removed it in 8.0.
    // On our PHP 8.3 parity target, closures export as \Closure::__set_state(array()).
    outerIndent = _makeIndent(idtLevel - 2)
    retstr = outerIndent + '\\Closure::__set_state(array(\n' + outerIndent + '))'
  } else if (type === 'resource') {
    // Resources treated as null for var_export
    retstr = 'NULL'
  } else {
    if (typeof mixedExpression === 'string') {
      retstr = "'" + mixedExpression.replace(/([\\'])/g, '\\$1').replace(/\0/g, '\\0') + "'"
    } else if (mixedExpression === null) {
      retstr = null
    } else if (typeof mixedExpression === 'number') {
      retstr = Number(mixedExpression)
    } else if (typeof mixedExpression === 'boolean') {
      retstr = Boolean(mixedExpression)
    } else {
      retstr = String(mixedExpression)
    }
  }

  if (!boolReturn) {
    echo(retstr)
    return null
  }

  return retstr
}

// 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/_helpers/_phpRuntimeState (Locutus helper dependency)
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/strings/echo (Locutus dependency module)
type EchoValue = PhpRuntimeValue

function echo(...args: EchoValue[]): void {
  //      discuss at: https://locutus.io/php/echo/
  // parity verified: PHP 8.3
  //     original by: Philip Peterson
  //     improved by: echo is bad
  //     improved by: Nate
  //     improved by: Brett Zamir (https://brett-zamir.me)
  //     improved by: Brett Zamir (https://brett-zamir.me)
  //     improved by: Brett Zamir (https://brett-zamir.me)
  //      revised by: Der Simon (https://innerdom.sourceforge.net/)
  //     bugfixed by: Eugene Bulkin (https://doubleaw.com/)
  //     bugfixed by: Brett Zamir (https://brett-zamir.me)
  //     bugfixed by: Brett Zamir (https://brett-zamir.me)
  //     bugfixed by: EdorFaus
  //          note 1: In 1.3.2 and earlier, this function wrote to the body of the document when it
  //          note 1: was called in webbrowsers, in addition to supporting XUL.
  //          note 1: This involved >100 lines of boilerplate to do this in a safe way.
  //          note 1: Since I can't imageine a complelling use-case for this, and XUL is deprecated
  //          note 1: I have removed this behavior in favor of just calling `console.log`
  //          note 2: You'll see functions depends on `echo` instead of `console.log` as we'll want
  //          note 2: to have 1 contact point to interface with the outside world, so that it's easy
  //          note 2: to support other ways of printing output.
  //      revised by: Kevin van Zonneveld (https://kvz.io)
  //        input by: JB
  //       example 1: echo('Hello world')
  //       returns 1: undefined

  return console.log(args.join(' '))
}

// php/var/var_export (target function module)
type VarExportInput = PhpRuntimeValue

type VarExportType =
  | 'resource'
  | 'function'
  | 'null'
  | 'array'
  | 'object'
  | 'string'
  | 'number'
  | 'boolean'
  | 'undefined'

type VarExportResult = string | number | boolean | null

function var_export(mixedExpression: VarExportInput, boolReturn: true, idtLevel?: number): VarExportResult

function var_export(mixedExpression: VarExportInput, boolReturn?: false | undefined, idtLevel?: number): null

function var_export(
  mixedExpression: VarExportInput,
  boolReturn?: boolean,
  idtLevel?: number,
): VarExportResult | null

function var_export(
  mixedExpression: VarExportInput,
  boolReturn?: boolean,
  idtLevel = 2,
): VarExportResult | null {
  //  discuss at: https://locutus.io/php/var_export/
  // original by: Philip Peterson
  // improved by: johnrembo
  // improved by: Brett Zamir (https://brett-zamir.me)
  //    input by: Brian Tafoya (https://www.premasolutions.com/)
  //    input by: Hans Henrik (https://hanshenrik.tk/)
  // bugfixed by: Brett Zamir (https://brett-zamir.me)
  // bugfixed by: Brett Zamir (https://brett-zamir.me)
  // bugfixed by: simivar (https://github.com/simivar)
  // bugfixed by: simivar (https://github.com/simivar)
  // bugfixed by: simivar (https://github.com/simivar)
  //   example 1: var_export(null)
  //   returns 1: null
  //   example 2: var_export({0: 'Kevin', 1: 'van', 2: 'Zonneveld'}, true)
  //   returns 2: "array (\n  0 => 'Kevin',\n  1 => 'van',\n  2 => 'Zonneveld',\n)"
  //   example 3: var data = 'Kevin'
  //   example 3: var_export(data, true)
  //   returns 3: "'Kevin'"
  //   example 4: var_export({0: 'Kevin', 1: 'van', 'lastName': 'Zonneveld'}, true)
  //   returns 4: "array (\n  0 => 'Kevin',\n  1 => 'van',\n  'lastName' => 'Zonneveld',\n)"
  //   example 5: var_export([], true)
  //   returns 5: "array (\n)"
  //   example 6: var_export({ test: [ 'a', 'b' ] }, true)
  //   returns 6: "array (\n  'test' => \n  array (\n    0 => 'a',\n    1 => 'b',\n  ),\n)"

  let retstr: VarExportResult = ''
  let iret = ''
  let value = ''
  let cnt = 0
  const x: string[] = []
  // We use the last argument (not part of PHP) to pass in
  // our indentation level
  let innerIndent = ''
  let outerIndent = ''
  const getFuncName = function (fn: { toString: () => string }): string {
    const name = /\W*function\s+([\w$]+)\s*\(/.exec(fn.toString())
    if (!name) {
      return '(Anonymous)'
    }
    return name[1] ?? '(Anonymous)'
  }

  const _isNormalInteger = function (input: string): boolean {
    const number = Math.floor(Number(input))
    return number !== Infinity && String(number) === input && number >= 0
  }

  const _makeIndent = function (indentLevel: number): string {
    return new Array(Math.max(indentLevel, 0) + 1).join(' ')
  }
  const __getType = function (inp: VarExportInput): VarExportType | null {
    let i = 0
    let match: RegExpMatchArray | null = null
    let cons = ''
    const types: Array<'boolean' | 'number' | 'string' | 'array'> = ['boolean', 'number', 'string', 'array']
    const jsType = typeof inp
    let type: VarExportType | null =
      jsType === 'boolean' ||
      jsType === 'number' ||
      jsType === 'string' ||
      jsType === 'function' ||
      jsType === 'undefined' ||
      jsType === 'object'
        ? jsType
        : null
    if (type === 'object' && typeof inp === 'object' && inp !== null) {
      const constructorValue = getPhpObjectEntry(inp, 'constructor')
      if (typeof constructorValue === 'function' && getFuncName(constructorValue) === 'LOCUTUS_Resource') {
        return 'resource'
      }
    }
    if (type === 'function') {
      return 'function'
    }
    if (type === 'object' && !inp) {
      // Should this be just null?
      return 'null'
    }
    if (type === 'object' && typeof inp === 'object' && inp !== null) {
      const constructorValue = getPhpObjectEntry(inp, 'constructor')
      if (typeof constructorValue !== 'function') {
        return 'object'
      }
      cons = constructorValue.toString()
      match = cons.match(/(\w+)\(/)
      if (match) {
        cons = (match[1] ?? '').toLowerCase()
      }
      for (i = 0; i < types.length; i++) {
        const knownType = types[i]
        if (knownType && cons === knownType) {
          type = knownType
          break
        }
      }
    }
    return type
  }
  const type = __getType(mixedExpression)

  if (type === null) {
    retstr = 'NULL'
  } else if (type === 'array' || type === 'object') {
    const source = toPhpArrayObject<VarExportInput>(mixedExpression)
    outerIndent = _makeIndent(idtLevel - 2)
    innerIndent = _makeIndent(idtLevel)
    for (const [key, entry] of Object.entries(source)) {
      value = ' '
      const subtype = __getType(entry)
      if (subtype === 'array' || subtype === 'object' || subtype === 'function') {
        value = ' \n'
      }
      value += String(var_export(entry, true, idtLevel + 2))
      const mappedKey = _isNormalInteger(key) ? key : `'${key}'`
      x[cnt++] = innerIndent + mappedKey + ' =>' + value
    }
    if (x.length > 0) {
      iret = x.join(',\n') + ',\n'
    }
    retstr = outerIndent + 'array (\n' + iret + outerIndent + ')'
  } else if (type === 'function') {
    // PHP deprecated create_function() in 7.2 and removed it in 8.0.
    // On our PHP 8.3 parity target, closures export as \Closure::__set_state(array()).
    outerIndent = _makeIndent(idtLevel - 2)
    retstr = outerIndent + '\\Closure::__set_state(array(\n' + outerIndent + '))'
  } else if (type === 'resource') {
    // Resources treated as null for var_export
    retstr = 'NULL'
  } else {
    if (typeof mixedExpression === 'string') {
      retstr = "'" + mixedExpression.replace(/([\\'])/g, '\\$1').replace(/\0/g, '\\0') + "'"
    } else if (mixedExpression === null) {
      retstr = null
    } else if (typeof mixedExpression === 'number') {
      retstr = Number(mixedExpression)
    } else if (typeof mixedExpression === 'boolean') {
      retstr = Boolean(mixedExpression)
    } else {
      retstr = String(mixedExpression)
    }
  }

  if (!boolReturn) {
    echo(retstr)
    return null
  }

  return retstr
}

// 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/_helpers/_phpRuntimeState (Locutus helper dependency)
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/strings/echo (Locutus dependency module)
function echo(...args) {
  //      discuss at: https://locutus.io/php/echo/
  // parity verified: PHP 8.3
  //     original by: Philip Peterson
  //     improved by: echo is bad
  //     improved by: Nate
  //     improved by: Brett Zamir (https://brett-zamir.me)
  //     improved by: Brett Zamir (https://brett-zamir.me)
  //     improved by: Brett Zamir (https://brett-zamir.me)
  //      revised by: Der Simon (https://innerdom.sourceforge.net/)
  //     bugfixed by: Eugene Bulkin (https://doubleaw.com/)
  //     bugfixed by: Brett Zamir (https://brett-zamir.me)
  //     bugfixed by: Brett Zamir (https://brett-zamir.me)
  //     bugfixed by: EdorFaus
  //          note 1: In 1.3.2 and earlier, this function wrote to the body of the document when it
  //          note 1: was called in webbrowsers, in addition to supporting XUL.
  //          note 1: This involved >100 lines of boilerplate to do this in a safe way.
  //          note 1: Since I can't imageine a complelling use-case for this, and XUL is deprecated
  //          note 1: I have removed this behavior in favor of just calling `console.log`
  //          note 2: You'll see functions depends on `echo` instead of `console.log` as we'll want
  //          note 2: to have 1 contact point to interface with the outside world, so that it's easy
  //          note 2: to support other ways of printing output.
  //      revised by: Kevin van Zonneveld (https://kvz.io)
  //        input by: JB
  //       example 1: echo('Hello world')
  //       returns 1: undefined

  return console.log(args.join(' '))
}

// php/var/var_export (target function module)

function var_export(mixedExpression, boolReturn, idtLevel = 2) {
  //  discuss at: https://locutus.io/php/var_export/
  // original by: Philip Peterson
  // improved by: johnrembo
  // improved by: Brett Zamir (https://brett-zamir.me)
  //    input by: Brian Tafoya (https://www.premasolutions.com/)
  //    input by: Hans Henrik (https://hanshenrik.tk/)
  // bugfixed by: Brett Zamir (https://brett-zamir.me)
  // bugfixed by: Brett Zamir (https://brett-zamir.me)
  // bugfixed by: simivar (https://github.com/simivar)
  // bugfixed by: simivar (https://github.com/simivar)
  // bugfixed by: simivar (https://github.com/simivar)
  //   example 1: var_export(null)
  //   returns 1: null
  //   example 2: var_export({0: 'Kevin', 1: 'van', 2: 'Zonneveld'}, true)
  //   returns 2: "array (\n  0 => 'Kevin',\n  1 => 'van',\n  2 => 'Zonneveld',\n)"
  //   example 3: var data = 'Kevin'
  //   example 3: var_export(data, true)
  //   returns 3: "'Kevin'"
  //   example 4: var_export({0: 'Kevin', 1: 'van', 'lastName': 'Zonneveld'}, true)
  //   returns 4: "array (\n  0 => 'Kevin',\n  1 => 'van',\n  'lastName' => 'Zonneveld',\n)"
  //   example 5: var_export([], true)
  //   returns 5: "array (\n)"
  //   example 6: var_export({ test: [ 'a', 'b' ] }, true)
  //   returns 6: "array (\n  'test' => \n  array (\n    0 => 'a',\n    1 => 'b',\n  ),\n)"

  let retstr = ''
  let iret = ''
  let value = ''
  let cnt = 0
  const x = []
  // We use the last argument (not part of PHP) to pass in
  // our indentation level
  let innerIndent = ''
  let outerIndent = ''
  const getFuncName = function (fn) {
    const name = /\W*function\s+([\w$]+)\s*\(/.exec(fn.toString())
    if (!name) {
      return '(Anonymous)'
    }
    return name[1] ?? '(Anonymous)'
  }

  const _isNormalInteger = function (input) {
    const number = Math.floor(Number(input))
    return number !== Infinity && String(number) === input && number >= 0
  }

  const _makeIndent = function (indentLevel) {
    return new Array(Math.max(indentLevel, 0) + 1).join(' ')
  }
  const __getType = function (inp) {
    let i = 0
    let match = null
    let cons = ''
    const types = ['boolean', 'number', 'string', 'array']
    const jsType = typeof inp
    let type =
      jsType === 'boolean' ||
      jsType === 'number' ||
      jsType === 'string' ||
      jsType === 'function' ||
      jsType === 'undefined' ||
      jsType === 'object'
        ? jsType
        : null
    if (type === 'object' && typeof inp === 'object' && inp !== null) {
      const constructorValue = getPhpObjectEntry(inp, 'constructor')
      if (typeof constructorValue === 'function' && getFuncName(constructorValue) === 'LOCUTUS_Resource') {
        return 'resource'
      }
    }
    if (type === 'function') {
      return 'function'
    }
    if (type === 'object' && !inp) {
      // Should this be just null?
      return 'null'
    }
    if (type === 'object' && typeof inp === 'object' && inp !== null) {
      const constructorValue = getPhpObjectEntry(inp, 'constructor')
      if (typeof constructorValue !== 'function') {
        return 'object'
      }
      cons = constructorValue.toString()
      match = cons.match(/(\w+)\(/)
      if (match) {
        cons = (match[1] ?? '').toLowerCase()
      }
      for (i = 0; i < types.length; i++) {
        const knownType = types[i]
        if (knownType && cons === knownType) {
          type = knownType
          break
        }
      }
    }
    return type
  }
  const type = __getType(mixedExpression)

  if (type === null) {
    retstr = 'NULL'
  } else if (type === 'array' || type === 'object') {
    const source = toPhpArrayObject(mixedExpression)
    outerIndent = _makeIndent(idtLevel - 2)
    innerIndent = _makeIndent(idtLevel)
    for (const [key, entry] of Object.entries(source)) {
      value = ' '
      const subtype = __getType(entry)
      if (subtype === 'array' || subtype === 'object' || subtype === 'function') {
        value = ' \n'
      }
      value += String(var_export(entry, true, idtLevel + 2))
      const mappedKey = _isNormalInteger(key) ? key : `'${key}'`
      x[cnt++] = innerIndent + mappedKey + ' =>' + value
    }
    if (x.length > 0) {
      iret = x.join(',\n') + ',\n'
    }
    retstr = outerIndent + 'array (\n' + iret + outerIndent + ')'
  } else if (type === 'function') {
    // PHP deprecated create_function() in 7.2 and removed it in 8.0.
    // On our PHP 8.3 parity target, closures export as \Closure::__set_state(array()).
    outerIndent = _makeIndent(idtLevel - 2)
    retstr = outerIndent + '\\Closure::__set_state(array(\n' + outerIndent + '))'
  } else if (type === 'resource') {
    // Resources treated as null for var_export
    retstr = 'NULL'
  } else {
    if (typeof mixedExpression === 'string') {
      retstr = "'" + mixedExpression.replace(/([\\'])/g, '\\$1').replace(/\0/g, '\\0') + "'"
    } else if (mixedExpression === null) {
      retstr = null
    } else if (typeof mixedExpression === 'number') {
      retstr = Number(mixedExpression)
    } else if (typeof mixedExpression === 'boolean') {
      retstr = Boolean(mixedExpression)
    } else {
      retstr = String(mixedExpression)
    }
  }

  if (!boolReturn) {
    echo(retstr)
    return null
  }

  return retstr
}

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 var functions

Star