PHP's strval in TypeScript

How to use

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

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

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	strval({red: 1, green: 2, blue: 3, white: 4})	'Object'

Dependencies

This function uses the following Locutus functions:

• gettype (php/var)

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

import type { PhpRuntimeValue } from '../_helpers/_phpTypes.ts'
import { gettype } from '../var/gettype.ts'

type StringValue = PhpRuntimeValue

export function strval(str: StringValue): string {
  //  discuss at: https://locutus.io/php/strval/
  // original by: Brett Zamir (https://brett-zamir.me)
  // improved by: Kevin van Zonneveld (https://kvz.io)
  // bugfixed by: Brett Zamir (https://brett-zamir.me)
  //   example 1: strval({red: 1, green: 2, blue: 3, white: 4})
  //   returns 1: 'Object'

  let type = ''

  if (str === null) {
    return ''
  }

  type = gettype(str)

  // Comment out the entire switch if you want JS-like
  // behavior instead of PHP behavior
  switch (type) {
    case 'boolean':
      if (str === true) {
        return '1'
      }
      return ''
    case 'array':
      return 'Array'
    case 'object':
      return 'Object'
  }

  return String(str)
}

import { gettype } from '../var/gettype.ts'

export function strval(str) {
  //  discuss at: https://locutus.io/php/strval/
  // original by: Brett Zamir (https://brett-zamir.me)
  // improved by: Kevin van Zonneveld (https://kvz.io)
  // bugfixed by: Brett Zamir (https://brett-zamir.me)
  //   example 1: strval({red: 1, green: 2, blue: 3, white: 4})
  //   returns 1: 'Object'

  let type = ''

  if (str === null) {
    return ''
  }

  type = gettype(str)

  // Comment out the entire switch if you want JS-like
  // behavior instead of PHP behavior
  switch (type) {
    case 'boolean':
      if (str === true) {
        return '1'
      }
      return ''
    case 'array':
      return 'Array'
    case 'object':
      return 'Object'
  }

  return String(str)
}

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

type PhpInput = {} | PhpNullish

type PhpScalar = string | number | boolean

type PhpPrimitive = PhpScalar | bigint

type PhpFunctionValue = (...args: PhpInput[]) => PhpInput

interface PhpRuntimeAssoc {
  [key: string]: PhpRuntimeValue
}

interface PhpRuntimeList extends Array<PhpRuntimeValue> {}

type PhpRuntimeValue = PhpPrimitive | PhpNullish | PhpRuntimeList | PhpRuntimeAssoc | PhpFunctionValue

// 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/var/is_float (Locutus dependency module)
function is_float(mixedVar: number): boolean {
  //      discuss at: https://locutus.io/php/is_float/
  // parity verified: PHP 8.3
  //     original by: Paulo Freitas
  //     bugfixed by: Brett Zamir (https://brett-zamir.me)
  //     improved by: WebDevHobo (https://webdevhobo.blogspot.com/)
  //     improved by: Rafał Kukawski (https://blog.kukawski.pl)
  //          note 1: 1.0 is simplified to 1 before it can be accessed by the function, this makes
  //          note 1: it different from the PHP implementation. We can't fix this unfortunately.
  //       example 1: is_float(186.31)
  //       returns 1: true

  return +mixedVar === mixedVar && (!isFinite(mixedVar) || !!(mixedVar % 1))
}

// php/var/gettype (Locutus dependency module)
const isFloat = is_float;

type TypeInput = PhpRuntimeValue

function gettype(mixedVar: TypeInput): string {
  //  discuss at: https://locutus.io/php/gettype/
  // original by: Paulo Freitas
  // improved by: Kevin van Zonneveld (https://kvz.io)
  // improved by: Douglas Crockford (https://javascript.crockford.com)
  // improved by: Brett Zamir (https://brett-zamir.me)
  //    input by: KELAN
  //      note 1: 1.0 is simplified to 1 before it can be accessed by the function, this makes
  //      note 1: it different from the PHP implementation. We can't fix this unfortunately.
  //   example 1: gettype(1)
  //   returns 1: 'integer'
  //   example 2: gettype(undefined)
  //   returns 2: 'undefined'
  //   example 3: gettype({0: 'Kevin van Zonneveld'})
  //   returns 3: 'object'
  //   example 4: gettype('foo')
  //   returns 4: 'string'
  //   example 5: gettype({0: function () {return false;}})
  //   returns 5: 'object'
  //   example 6: gettype({0: 'test', length: 1, splice: function () {}})
  //   returns 6: 'object'
  //   example 7: gettype(['test'])
  //   returns 7: 'array'

  let s: string = typeof mixedVar
  let name = ''
  const _getFuncName = function (fn: TypeInput): string {
    const funcNameMatch = /\W*function\s+([\w$]+)\s*\(/.exec(String(fn))
    if (!funcNameMatch) {
      return '(Anonymous)'
    }
    return funcNameMatch[1] ?? '(Anonymous)'
  }

  if (s === 'object') {
    if (typeof mixedVar === 'object' && mixedVar !== null) {
      const objectLike = mixedVar
      const objectLength = getPhpObjectEntry(objectLike, 'length')
      const objectSplice = getPhpObjectEntry(objectLike, 'splice')
      // From: https://javascript.crockford.com/remedial.html
      // @todo: Break up this lengthy if statement
      if (
        typeof objectLength === 'number' &&
        !Object.prototype.propertyIsEnumerable.call(objectLike, 'length') &&
        typeof objectSplice === 'function'
      ) {
        s = 'array'
      } else {
        const constructorValue = getPhpObjectEntry(objectLike, 'constructor')
        if (!constructorValue) {
          return s
        }
        name = _getFuncName(constructorValue)
        if (name === 'Date') {
          // not in PHP
          s = 'date'
        } else if (name === 'RegExp') {
          // not in PHP
          s = 'regexp'
        } else if (name === 'LOCUTUS_Resource') {
          // Check against our own resource constructor
          s = 'resource'
        }
      }
    } else {
      s = 'null'
    }
  } else if (typeof mixedVar === 'number') {
    s = isFloat(mixedVar) ? 'double' : 'integer'
  }

  return s
}

// php/var/strval (target function module)
type StringValue = PhpRuntimeValue

function strval(str: StringValue): string {
  //  discuss at: https://locutus.io/php/strval/
  // original by: Brett Zamir (https://brett-zamir.me)
  // improved by: Kevin van Zonneveld (https://kvz.io)
  // bugfixed by: Brett Zamir (https://brett-zamir.me)
  //   example 1: strval({red: 1, green: 2, blue: 3, white: 4})
  //   returns 1: 'Object'

  let type = ''

  if (str === null) {
    return ''
  }

  type = gettype(str)

  // Comment out the entire switch if you want JS-like
  // behavior instead of PHP behavior
  switch (type) {
    case 'boolean':
      if (str === true) {
        return '1'
      }
      return ''
    case 'array':
      return 'Array'
    case 'object':
      return 'Object'
  }

  return String(str)
}

// 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/var/is_float (Locutus dependency module)
function is_float(mixedVar) {
  //      discuss at: https://locutus.io/php/is_float/
  // parity verified: PHP 8.3
  //     original by: Paulo Freitas
  //     bugfixed by: Brett Zamir (https://brett-zamir.me)
  //     improved by: WebDevHobo (https://webdevhobo.blogspot.com/)
  //     improved by: Rafał Kukawski (https://blog.kukawski.pl)
  //          note 1: 1.0 is simplified to 1 before it can be accessed by the function, this makes
  //          note 1: it different from the PHP implementation. We can't fix this unfortunately.
  //       example 1: is_float(186.31)
  //       returns 1: true

  return +mixedVar === mixedVar && (!isFinite(mixedVar) || !!(mixedVar % 1))
}

// php/var/gettype (Locutus dependency module)
const isFloat = is_float

function gettype(mixedVar) {
  //  discuss at: https://locutus.io/php/gettype/
  // original by: Paulo Freitas
  // improved by: Kevin van Zonneveld (https://kvz.io)
  // improved by: Douglas Crockford (https://javascript.crockford.com)
  // improved by: Brett Zamir (https://brett-zamir.me)
  //    input by: KELAN
  //      note 1: 1.0 is simplified to 1 before it can be accessed by the function, this makes
  //      note 1: it different from the PHP implementation. We can't fix this unfortunately.
  //   example 1: gettype(1)
  //   returns 1: 'integer'
  //   example 2: gettype(undefined)
  //   returns 2: 'undefined'
  //   example 3: gettype({0: 'Kevin van Zonneveld'})
  //   returns 3: 'object'
  //   example 4: gettype('foo')
  //   returns 4: 'string'
  //   example 5: gettype({0: function () {return false;}})
  //   returns 5: 'object'
  //   example 6: gettype({0: 'test', length: 1, splice: function () {}})
  //   returns 6: 'object'
  //   example 7: gettype(['test'])
  //   returns 7: 'array'

  let s = typeof mixedVar
  let name = ''
  const _getFuncName = function (fn) {
    const funcNameMatch = /\W*function\s+([\w$]+)\s*\(/.exec(String(fn))
    if (!funcNameMatch) {
      return '(Anonymous)'
    }
    return funcNameMatch[1] ?? '(Anonymous)'
  }

  if (s === 'object') {
    if (typeof mixedVar === 'object' && mixedVar !== null) {
      const objectLike = mixedVar
      const objectLength = getPhpObjectEntry(objectLike, 'length')
      const objectSplice = getPhpObjectEntry(objectLike, 'splice')
      // From: https://javascript.crockford.com/remedial.html
      // @todo: Break up this lengthy if statement
      if (
        typeof objectLength === 'number' &&
        !Object.prototype.propertyIsEnumerable.call(objectLike, 'length') &&
        typeof objectSplice === 'function'
      ) {
        s = 'array'
      } else {
        const constructorValue = getPhpObjectEntry(objectLike, 'constructor')
        if (!constructorValue) {
          return s
        }
        name = _getFuncName(constructorValue)
        if (name === 'Date') {
          // not in PHP
          s = 'date'
        } else if (name === 'RegExp') {
          // not in PHP
          s = 'regexp'
        } else if (name === 'LOCUTUS_Resource') {
          // Check against our own resource constructor
          s = 'resource'
        }
      }
    } else {
      s = 'null'
    }
  } else if (typeof mixedVar === 'number') {
    s = isFloat(mixedVar) ? 'double' : 'integer'
  }

  return s
}

// php/var/strval (target function module)
function strval(str) {
  //  discuss at: https://locutus.io/php/strval/
  // original by: Brett Zamir (https://brett-zamir.me)
  // improved by: Kevin van Zonneveld (https://kvz.io)
  // bugfixed by: Brett Zamir (https://brett-zamir.me)
  //   example 1: strval({red: 1, green: 2, blue: 3, white: 4})
  //   returns 1: 'Object'

  let type = ''

  if (str === null) {
    return ''
  }

  type = gettype(str)

  // Comment out the entire switch if you want JS-like
  // behavior instead of PHP behavior
  switch (type) {
    case 'boolean':
      if (str === true) {
        return '1'
      }
      return ''
    case 'array':
      return 'Array'
    case 'object':
      return 'Object'
  }

  return String(str)
}

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