PHP's print_r in TypeScript

How to use

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

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

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	print_r(1, true)	'1'

Dependencies

This function uses the following Locutus functions:

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

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

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

type PrintValue = PhpRuntimeValue

export function print_r(array: PrintValue, returnVal?: boolean): string | true {
  //      discuss at: https://locutus.io/php/print_r/
  // parity verified: PHP 8.3
  //     original by: Michael White (https://getsprink.com)
  //     improved by: Ben Bryan
  //     improved by: Brett Zamir (https://brett-zamir.me)
  //     improved by: Kevin van Zonneveld (https://kvz.io)
  //        input by: Brett Zamir (https://brett-zamir.me)
  //       example 1: print_r(1, true)
  //       returns 1: '1'

  let output = ''
  const padChar = ' '
  const padVal = 4

  const _repeatChar = function (len: number, padChar: string): string {
    let str = ''
    for (let i = 0; i < len; i++) {
      str += padChar
    }
    return str
  }
  const _formatArray = function (obj: PrintValue, curDepth: number, padVal: number, padChar: string): string {
    if (curDepth > 0) {
      curDepth++
    }

    const basePad = _repeatChar(padVal * curDepth, padChar)
    const thickPad = _repeatChar(padVal * (curDepth + 1), padChar)
    let str = ''

    if (typeof obj === 'object' && obj !== null && obj.constructor) {
      const objectValue = toPhpArrayObject(obj)
      str += 'Array\n' + basePad + '(\n'
      for (const key in objectValue) {
        const value = objectValue[key]
        if (Array.isArray(value)) {
          str += thickPad
          str += '['
          str += key
          str += '] => '
          str += _formatArray(value, curDepth + 1, padVal, padChar)
        } else {
          str += thickPad
          str += '['
          str += key
          str += '] => '
          str += value
          str += '\n'
        }
      }
      str += basePad + ')\n'
    } else if (obj === null || obj === undefined) {
      str = ''
    } else {
      // for our "resource" class
      str = String(obj)
    }

    return str
  }

  output = _formatArray(array, 0, padVal, padChar)

  if (returnVal !== true) {
    echo(output)
    return true
  }
  return output
}

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

export function print_r(array, returnVal) {
  //      discuss at: https://locutus.io/php/print_r/
  // parity verified: PHP 8.3
  //     original by: Michael White (https://getsprink.com)
  //     improved by: Ben Bryan
  //     improved by: Brett Zamir (https://brett-zamir.me)
  //     improved by: Kevin van Zonneveld (https://kvz.io)
  //        input by: Brett Zamir (https://brett-zamir.me)
  //       example 1: print_r(1, true)
  //       returns 1: '1'

  let output = ''
  const padChar = ' '
  const padVal = 4

  const _repeatChar = function (len, padChar) {
    let str = ''
    for (let i = 0; i < len; i++) {
      str += padChar
    }
    return str
  }
  const _formatArray = function (obj, curDepth, padVal, padChar) {
    if (curDepth > 0) {
      curDepth++
    }

    const basePad = _repeatChar(padVal * curDepth, padChar)
    const thickPad = _repeatChar(padVal * (curDepth + 1), padChar)
    let str = ''

    if (typeof obj === 'object' && obj !== null && obj.constructor) {
      const objectValue = toPhpArrayObject(obj)
      str += 'Array\n' + basePad + '(\n'
      for (const key in objectValue) {
        const value = objectValue[key]
        if (Array.isArray(value)) {
          str += thickPad
          str += '['
          str += key
          str += '] => '
          str += _formatArray(value, curDepth + 1, padVal, padChar)
        } else {
          str += thickPad
          str += '['
          str += key
          str += '] => '
          str += value
          str += '\n'
        }
      }
      str += basePad + ')\n'
    } else if (obj === null || obj === undefined) {
      str = ''
    } else {
      // for our "resource" class
      str = String(obj)
    }

    return str
  }

  output = _formatArray(array, 0, padVal, padChar)

  if (returnVal !== true) {
    echo(output)
    return true
  }
  return output
}

// 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/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/print_r (target function module)
type PrintValue = PhpRuntimeValue

function print_r(array: PrintValue, returnVal?: boolean): string | true {
  //      discuss at: https://locutus.io/php/print_r/
  // parity verified: PHP 8.3
  //     original by: Michael White (https://getsprink.com)
  //     improved by: Ben Bryan
  //     improved by: Brett Zamir (https://brett-zamir.me)
  //     improved by: Kevin van Zonneveld (https://kvz.io)
  //        input by: Brett Zamir (https://brett-zamir.me)
  //       example 1: print_r(1, true)
  //       returns 1: '1'

  let output = ''
  const padChar = ' '
  const padVal = 4

  const _repeatChar = function (len: number, padChar: string): string {
    let str = ''
    for (let i = 0; i < len; i++) {
      str += padChar
    }
    return str
  }
  const _formatArray = function (obj: PrintValue, curDepth: number, padVal: number, padChar: string): string {
    if (curDepth > 0) {
      curDepth++
    }

    const basePad = _repeatChar(padVal * curDepth, padChar)
    const thickPad = _repeatChar(padVal * (curDepth + 1), padChar)
    let str = ''

    if (typeof obj === 'object' && obj !== null && obj.constructor) {
      const objectValue = toPhpArrayObject(obj)
      str += 'Array\n' + basePad + '(\n'
      for (const key in objectValue) {
        const value = objectValue[key]
        if (Array.isArray(value)) {
          str += thickPad
          str += '['
          str += key
          str += '] => '
          str += _formatArray(value, curDepth + 1, padVal, padChar)
        } else {
          str += thickPad
          str += '['
          str += key
          str += '] => '
          str += value
          str += '\n'
        }
      }
      str += basePad + ')\n'
    } else if (obj === null || obj === undefined) {
      str = ''
    } else {
      // for our "resource" class
      str = String(obj)
    }

    return str
  }

  output = _formatArray(array, 0, padVal, padChar)

  if (returnVal !== true) {
    echo(output)
    return true
  }
  return output
}

// 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/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/print_r (target function module)
function print_r(array, returnVal) {
  //      discuss at: https://locutus.io/php/print_r/
  // parity verified: PHP 8.3
  //     original by: Michael White (https://getsprink.com)
  //     improved by: Ben Bryan
  //     improved by: Brett Zamir (https://brett-zamir.me)
  //     improved by: Kevin van Zonneveld (https://kvz.io)
  //        input by: Brett Zamir (https://brett-zamir.me)
  //       example 1: print_r(1, true)
  //       returns 1: '1'

  let output = ''
  const padChar = ' '
  const padVal = 4

  const _repeatChar = function (len, padChar) {
    let str = ''
    for (let i = 0; i < len; i++) {
      str += padChar
    }
    return str
  }
  const _formatArray = function (obj, curDepth, padVal, padChar) {
    if (curDepth > 0) {
      curDepth++
    }

    const basePad = _repeatChar(padVal * curDepth, padChar)
    const thickPad = _repeatChar(padVal * (curDepth + 1), padChar)
    let str = ''

    if (typeof obj === 'object' && obj !== null && obj.constructor) {
      const objectValue = toPhpArrayObject(obj)
      str += 'Array\n' + basePad + '(\n'
      for (const key in objectValue) {
        const value = objectValue[key]
        if (Array.isArray(value)) {
          str += thickPad
          str += '['
          str += key
          str += '] => '
          str += _formatArray(value, curDepth + 1, padVal, padChar)
        } else {
          str += thickPad
          str += '['
          str += key
          str += '] => '
          str += value
          str += '\n'
        }
      }
      str += basePad + ')\n'
    } else if (obj === null || obj === undefined) {
      str = ''
    } else {
      // for our "resource" class
      str = String(obj)
    }

    return str
  }

  output = _formatArray(array, 0, padVal, padChar)

  if (returnVal !== true) {
    echo(output)
    return true
  }
  return output
}

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