PHP's assert_options in TypeScript

How to use

Install via yarn add locutus and import: import { assert_options } from 'locutus/php/info/assert_options'.

Or with CommonJS: const { assert_options } = require('locutus/php/info/assert_options')

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	assert_options('ASSERT_CALLBACK')	null

Dependencies

This function uses the following Locutus functions:

• ini_get (php/info)

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

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

type AssertOptionValue = PhpRuntimeValue

export function assert_options(what: string, _value?: AssertOptionValue): string | number | null {
  //  discuss at: https://locutus.io/php/assert_options/
  // original by: Brett Zamir (https://brett-zamir.me)
  //   example 1: assert_options('ASSERT_CALLBACK')
  //   returns 1: null

  let iniKey: string
  let defaultVal: number | null
  switch (what) {
    case 'ASSERT_ACTIVE':
      iniKey = 'assert.active'
      defaultVal = 1
      break
    case 'ASSERT_WARNING': {
      iniKey = 'assert.warning'
      defaultVal = 1
      let msg = 'We have not yet implemented warnings for us to throw '
      msg += 'in JavaScript (assert_options())'
      throw new Error(msg)
    }
    case 'ASSERT_BAIL':
      iniKey = 'assert.bail'
      defaultVal = 0
      break
    case 'ASSERT_QUIET_EVAL':
      iniKey = 'assert.quiet_eval'
      defaultVal = 0
      break
    case 'ASSERT_CALLBACK':
      iniKey = 'assert.callback'
      defaultVal = null
      break
    default:
      throw new Error('Improper type for assert_options()')
  }

  // I presume this is to be the most recent value, instead of the default value
  const iniVal = ini_get(iniKey)
  return iniVal === '' ? defaultVal : iniVal
}

import { ini_get } from './ini_get.ts'

export function assert_options(what, _value) {
  //  discuss at: https://locutus.io/php/assert_options/
  // original by: Brett Zamir (https://brett-zamir.me)
  //   example 1: assert_options('ASSERT_CALLBACK')
  //   returns 1: null

  let iniKey
  let defaultVal
  switch (what) {
    case 'ASSERT_ACTIVE':
      iniKey = 'assert.active'
      defaultVal = 1
      break
    case 'ASSERT_WARNING': {
      iniKey = 'assert.warning'
      defaultVal = 1
      let msg = 'We have not yet implemented warnings for us to throw '
      msg += 'in JavaScript (assert_options())'
      throw new Error(msg)
    }
    case 'ASSERT_BAIL':
      iniKey = 'assert.bail'
      defaultVal = 0
      break
    case 'ASSERT_QUIET_EVAL':
      iniKey = 'assert.quiet_eval'
      defaultVal = 0
      break
    case 'ASSERT_CALLBACK':
      iniKey = 'assert.callback'
      defaultVal = null
      break
    default:
      throw new Error('Improper type for assert_options()')
  }

  // I presume this is to be the most recent value, instead of the default value
  const iniVal = ini_get(iniKey)
  return iniVal === '' ? defaultVal : iniVal
}

// 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 isPhpList<T = PhpInput>(value: PhpInput): value is PhpList<T> {
  return Array.isArray(value)
}

function isObjectLike(value: PhpInput): value is PhpArrayLike<PhpInput> {
  return typeof value === 'object' && value !== null
}

function isPhpAssocObject<T = PhpInput>(value: PhpInput): value is PhpAssoc<T> {
  return isObjectLike(value) && !isPhpList(value)
}

// php/_helpers/_phpRuntimeState (Locutus helper dependency)
interface IniEntry {
  local_value?: PhpInput
}

type LocaleEntry = PhpAssoc<PhpInput> & {
  sorting?: (left: PhpInput, right: PhpInput) => number
}

type LocaleCategoryMap = PhpAssoc<string | undefined>

interface LocutusRuntimeContainer {
  php?: PhpAssoc<PhpInput>
}

type GlobalWithLocutus = {
  $locutus?: LocutusRuntimeContainer
  [key: string]: PhpInput
}

interface PhpRuntimeState {
  ini: PhpAssoc<IniEntry | undefined>
  locales: PhpAssoc<LocaleEntry | undefined>
  localeCategories: LocaleCategoryMap
  pointers: PhpList<PhpInput>
  locale_default: string | undefined
}

const isIniBag = (value: PhpInput): value is PhpAssoc<IniEntry | undefined> =>
  isPhpAssocObject<IniEntry | undefined>(value)

const isLocaleBag = (value: PhpInput): value is PhpAssoc<LocaleEntry | undefined> =>
  isPhpAssocObject<LocaleEntry | undefined>(value)

const isLocaleCategoryBag = (value: PhpInput): value is LocaleCategoryMap => isPhpAssocObject<string | undefined>(value)

const globalContext: GlobalWithLocutus =
  typeof window === 'object' && window !== null ? window : typeof global === 'object' && global !== null ? global : {}

const ensurePhpRuntimeObject = (): PhpAssoc<PhpInput> => {
  let locutus = globalContext.$locutus
  if (typeof locutus !== 'object' || locutus === null) {
    locutus = {}
    globalContext.$locutus = locutus
  }

  let php = locutus.php
  if (typeof php !== 'object' || php === null) {
    php = {}
    locutus.php = php
  }

  return php
}

function ensurePhpRuntimeState(): PhpRuntimeState {
  const php = ensurePhpRuntimeObject()
  const iniValue = php.ini
  const localesValue = php.locales
  const localeCategoriesValue = php.localeCategories
  const pointersValue = php.pointers

  const ini = isIniBag(iniValue) ? iniValue : {}
  const locales = isLocaleBag(localesValue) ? localesValue : {}
  const localeCategories = isLocaleCategoryBag(localeCategoriesValue) ? localeCategoriesValue : {}
  const pointers: PhpList<PhpInput> = Array.isArray(pointersValue) ? pointersValue : []

  if (iniValue !== ini) {
    php.ini = ini
  }
  if (localesValue !== locales) {
    php.locales = locales
  }
  if (localeCategoriesValue !== localeCategories) {
    php.localeCategories = localeCategories
  }
  if (pointersValue !== pointers) {
    php.pointers = pointers
  }

  const localeDefaultValue = php.locale_default
  const localeDefault = typeof localeDefaultValue === 'string' ? localeDefaultValue : undefined

  return {
    ini,
    locales,
    localeCategories,
    pointers,
    locale_default: localeDefault,
  }
}

// php/info/ini_get (Locutus dependency module)
function ini_get(varname: string): string {
  //  discuss at: https://locutus.io/php/ini_get/
  // original by: Brett Zamir (https://brett-zamir.me)
  //      note 1: The ini values must be set by ini_set or manually within an ini file
  //   example 1: ini_set('date.timezone', 'Asia/Hong_Kong')
  //   example 1: ini_get('date.timezone')
  //   returns 1: 'Asia/Hong_Kong'

  const runtime = ensurePhpRuntimeState()
  const entry = runtime.ini[varname]

  if (entry && entry.local_value !== undefined) {
    if (entry.local_value === null) {
      return ''
    }
    return String(entry.local_value)
  }

  return ''
}

// php/info/assert_options (target function module)
type AssertOptionValue = PhpRuntimeValue

function assert_options(what: string, _value?: AssertOptionValue): string | number | null {
  //  discuss at: https://locutus.io/php/assert_options/
  // original by: Brett Zamir (https://brett-zamir.me)
  //   example 1: assert_options('ASSERT_CALLBACK')
  //   returns 1: null

  let iniKey: string
  let defaultVal: number | null
  switch (what) {
    case 'ASSERT_ACTIVE':
      iniKey = 'assert.active'
      defaultVal = 1
      break
    case 'ASSERT_WARNING': {
      iniKey = 'assert.warning'
      defaultVal = 1
      let msg = 'We have not yet implemented warnings for us to throw '
      msg += 'in JavaScript (assert_options())'
      throw new Error(msg)
    }
    case 'ASSERT_BAIL':
      iniKey = 'assert.bail'
      defaultVal = 0
      break
    case 'ASSERT_QUIET_EVAL':
      iniKey = 'assert.quiet_eval'
      defaultVal = 0
      break
    case 'ASSERT_CALLBACK':
      iniKey = 'assert.callback'
      defaultVal = null
      break
    default:
      throw new Error('Improper type for assert_options()')
  }

  // I presume this is to be the most recent value, instead of the default value
  const iniVal = ini_get(iniKey)
  return iniVal === '' ? defaultVal : iniVal
}

// php/_helpers/_phpTypes (Locutus helper dependency)

function isObjectLike(value) {
  return typeof value === 'object' && value !== null
}

function isPhpAssocObject(value) {
  return isObjectLike(value) && !Array.isArray(value)
}

// php/_helpers/_phpRuntimeState (Locutus helper dependency)

const globalContext =
  typeof window === 'object' && window !== null ? window : typeof global === 'object' && global !== null ? global : {}

const ensurePhpRuntimeObject = () => {
  let locutus = globalContext.$locutus
  if (typeof locutus !== 'object' || locutus === null) {
    locutus = {}
    globalContext.$locutus = locutus
  }

  let php = locutus.php
  if (typeof php !== 'object' || php === null) {
    php = {}
    locutus.php = php
  }

  return php
}

function ensurePhpRuntimeState() {
  const php = ensurePhpRuntimeObject()
  const iniValue = php.ini
  const localesValue = php.locales
  const localeCategoriesValue = php.localeCategories
  const pointersValue = php.pointers

  const ini = isPhpAssocObject(iniValue) ? iniValue : {}
  const locales = isPhpAssocObject(localesValue) ? localesValue : {}
  const localeCategories = isPhpAssocObject(localeCategoriesValue) ? localeCategoriesValue : {}
  const pointers = Array.isArray(pointersValue) ? pointersValue : []

  if (iniValue !== ini) {
    php.ini = ini
  }
  if (localesValue !== locales) {
    php.locales = locales
  }
  if (localeCategoriesValue !== localeCategories) {
    php.localeCategories = localeCategories
  }
  if (pointersValue !== pointers) {
    php.pointers = pointers
  }

  const localeDefaultValue = php.locale_default
  const localeDefault = typeof localeDefaultValue === 'string' ? localeDefaultValue : undefined

  return {
    ini,
    locales,
    localeCategories,
    pointers,
    locale_default: localeDefault,
  }
}

// php/info/ini_get (Locutus dependency module)
function ini_get(varname) {
  //  discuss at: https://locutus.io/php/ini_get/
  // original by: Brett Zamir (https://brett-zamir.me)
  //      note 1: The ini values must be set by ini_set or manually within an ini file
  //   example 1: ini_set('date.timezone', 'Asia/Hong_Kong')
  //   example 1: ini_get('date.timezone')
  //   returns 1: 'Asia/Hong_Kong'

  const runtime = ensurePhpRuntimeState()
  const entry = runtime.ini[varname]

  if (entry && entry.local_value !== undefined) {
    if (entry.local_value === null) {
      return ''
    }
    return String(entry.local_value)
  }

  return ''
}

// php/info/assert_options (target function module)
function assert_options(what, _value) {
  //  discuss at: https://locutus.io/php/assert_options/
  // original by: Brett Zamir (https://brett-zamir.me)
  //   example 1: assert_options('ASSERT_CALLBACK')
  //   returns 1: null

  let iniKey
  let defaultVal
  switch (what) {
    case 'ASSERT_ACTIVE':
      iniKey = 'assert.active'
      defaultVal = 1
      break
    case 'ASSERT_WARNING': {
      iniKey = 'assert.warning'
      defaultVal = 1
      let msg = 'We have not yet implemented warnings for us to throw '
      msg += 'in JavaScript (assert_options())'
      throw new Error(msg)
    }
    case 'ASSERT_BAIL':
      iniKey = 'assert.bail'
      defaultVal = 0
      break
    case 'ASSERT_QUIET_EVAL':
      iniKey = 'assert.quiet_eval'
      defaultVal = 0
      break
    case 'ASSERT_CALLBACK':
      iniKey = 'assert.callback'
      defaultVal = null
      break
    default:
      throw new Error('Improper type for assert_options()')
  }

  // I presume this is to be the most recent value, instead of the default value
  const iniVal = ini_get(iniKey)
  return iniVal === '' ? defaultVal : iniVal
}

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

Star