PHP's ini_set in TypeScript

How to use

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

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

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	ini_set('date.timezone', 'Asia/Hong_Kong') ini_set('date.timezone', 'America/Chicago')	'Asia/Hong_Kong'

Notes

• This will not set a global_value or access level for the ini item

Dependencies

This function uses the following Locutus functions:

• _phpRuntimeState (php/_helpers)

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

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

type IniScalar = string | number | boolean | null
type IniEntryValue = IniScalar | IniObject | IniEntryValue[]
type IniObject = { [key: string]: IniEntryValue }
export type IniValue = IniEntryValue | undefined

type IniCandidate = PhpRuntimeValue | undefined

const isIniScalar = (value: IniCandidate): value is IniScalar =>
  typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean' || value === null

const isIniObject = (value: IniCandidate): value is IniObject =>
  typeof value === 'object' && value !== null && !Array.isArray(value)

const isIniArray = (value: IniCandidate): value is IniEntryValue[] =>
  Array.isArray(value) && value.every((item: IniCandidate) => isIniEntryValue(item))

const isIniEntryValue = (value: IniCandidate): value is IniEntryValue =>
  isIniScalar(value) || isIniObject(value) || isIniArray(value)

const isIniValue = (value: IniCandidate): value is Exclude<IniValue, undefined> => isIniEntryValue(value)

export function ini_set(varname: string, newvalue: IniValue): IniValue | undefined {
  //      discuss at: https://locutus.io/php/ini_set/
  // parity verified: PHP 8.3
  //     original by: Brett Zamir (https://brett-zamir.me)
  //          note 1: This will not set a global_value or access level for the ini item
  //       example 1: ini_set('date.timezone', 'Asia/Hong_Kong')
  //       example 1: ini_set('date.timezone', 'America/Chicago')
  //       returns 1: 'Asia/Hong_Kong'

  const runtime = ensurePhpRuntimeState()
  const entry = runtime.ini[varname] ?? (runtime.ini[varname] = {})
  const currentValue = entry.local_value
  const oldval: IniValue | undefined =
    typeof currentValue === 'undefined' ? undefined : isIniValue(currentValue) ? currentValue : undefined

  let normalizedValue = newvalue
  const lowerStr = String(newvalue).toLowerCase().trim()
  if (newvalue === true || lowerStr === 'on' || lowerStr === '1') {
    normalizedValue = 'on'
  }
  if (newvalue === false || lowerStr === 'off' || lowerStr === '0') {
    normalizedValue = 'off'
  }

  const setArrayValue = () => {
    // Although these are set individually, they are all accumulated.
    if (typeof entry.local_value === 'undefined') {
      entry.local_value = [normalizedValue]
      return
    }

    if (Array.isArray(entry.local_value)) {
      entry.local_value.push(normalizedValue)
      return
    }

    entry.local_value = [entry.local_value, normalizedValue]
  }

  switch (varname) {
    case 'extension':
      setArrayValue()
      break
    default:
      entry.local_value = normalizedValue
      break
  }

  return oldval
}

import { ensurePhpRuntimeState } from '../_helpers/_phpRuntimeState.ts'

const isIniScalar = (value) =>
  typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean' || value === null

const isIniObject = (value) => typeof value === 'object' && value !== null && !Array.isArray(value)

const isIniArray = (value) => Array.isArray(value) && value.every((item) => isIniEntryValue(item))

const isIniEntryValue = (value) => isIniScalar(value) || isIniObject(value) || isIniArray(value)

const isIniValue = (value) => isIniEntryValue(value)

export function ini_set(varname, newvalue) {
  //      discuss at: https://locutus.io/php/ini_set/
  // parity verified: PHP 8.3
  //     original by: Brett Zamir (https://brett-zamir.me)
  //          note 1: This will not set a global_value or access level for the ini item
  //       example 1: ini_set('date.timezone', 'Asia/Hong_Kong')
  //       example 1: ini_set('date.timezone', 'America/Chicago')
  //       returns 1: 'Asia/Hong_Kong'

  const runtime = ensurePhpRuntimeState()
  const entry = runtime.ini[varname] ?? (runtime.ini[varname] = {})
  const currentValue = entry.local_value
  const oldval = typeof currentValue === 'undefined' ? undefined : isIniValue(currentValue) ? currentValue : undefined

  let normalizedValue = newvalue
  const lowerStr = String(newvalue).toLowerCase().trim()
  if (newvalue === true || lowerStr === 'on' || lowerStr === '1') {
    normalizedValue = 'on'
  }
  if (newvalue === false || lowerStr === 'off' || lowerStr === '0') {
    normalizedValue = 'off'
  }

  const setArrayValue = () => {
    // Although these are set individually, they are all accumulated.
    if (typeof entry.local_value === 'undefined') {
      entry.local_value = [normalizedValue]
      return
    }

    if (Array.isArray(entry.local_value)) {
      entry.local_value.push(normalizedValue)
      return
    }

    entry.local_value = [entry.local_value, normalizedValue]
  }

  switch (varname) {
    case 'extension':
      setArrayValue()
      break
    default:
      entry.local_value = normalizedValue
      break
  }

  return oldval
}

// 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_set (target function module)
type IniScalar = string | number | boolean | null

type IniEntryValue = IniScalar | IniObject | IniEntryValue[]

type IniObject = { [key: string]: IniEntryValue }

type IniValue = IniEntryValue | undefined

type IniCandidate = PhpRuntimeValue | undefined

const isIniScalar = (value: IniCandidate): value is IniScalar =>
  typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean' || value === null

const isIniObject = (value: IniCandidate): value is IniObject =>
  typeof value === 'object' && value !== null && !Array.isArray(value)

const isIniArray = (value: IniCandidate): value is IniEntryValue[] =>
  Array.isArray(value) && value.every((item: IniCandidate) => isIniEntryValue(item))

const isIniEntryValue = (value: IniCandidate): value is IniEntryValue =>
  isIniScalar(value) || isIniObject(value) || isIniArray(value)

const isIniValue = (value: IniCandidate): value is Exclude<IniValue, undefined> => isIniEntryValue(value)

function ini_set(varname: string, newvalue: IniValue): IniValue | undefined {
  //      discuss at: https://locutus.io/php/ini_set/
  // parity verified: PHP 8.3
  //     original by: Brett Zamir (https://brett-zamir.me)
  //          note 1: This will not set a global_value or access level for the ini item
  //       example 1: ini_set('date.timezone', 'Asia/Hong_Kong')
  //       example 1: ini_set('date.timezone', 'America/Chicago')
  //       returns 1: 'Asia/Hong_Kong'

  const runtime = ensurePhpRuntimeState()
  const entry = runtime.ini[varname] ?? (runtime.ini[varname] = {})
  const currentValue = entry.local_value
  const oldval: IniValue | undefined =
    typeof currentValue === 'undefined' ? undefined : isIniValue(currentValue) ? currentValue : undefined

  let normalizedValue = newvalue
  const lowerStr = String(newvalue).toLowerCase().trim()
  if (newvalue === true || lowerStr === 'on' || lowerStr === '1') {
    normalizedValue = 'on'
  }
  if (newvalue === false || lowerStr === 'off' || lowerStr === '0') {
    normalizedValue = 'off'
  }

  const setArrayValue = () => {
    // Although these are set individually, they are all accumulated.
    if (typeof entry.local_value === 'undefined') {
      entry.local_value = [normalizedValue]
      return
    }

    if (Array.isArray(entry.local_value)) {
      entry.local_value.push(normalizedValue)
      return
    }

    entry.local_value = [entry.local_value, normalizedValue]
  }

  switch (varname) {
    case 'extension':
      setArrayValue()
      break
    default:
      entry.local_value = normalizedValue
      break
  }

  return oldval
}

// 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_set (target function module)
const isIniScalar = (value) =>
  typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean' || value === null

const isIniObject = (value) => typeof value === 'object' && value !== null && !Array.isArray(value)

const isIniArray = (value) => Array.isArray(value) && value.every((item) => isIniEntryValue(item))

const isIniEntryValue = (value) => isIniScalar(value) || isIniObject(value) || isIniArray(value)

function ini_set(varname, newvalue) {
  //      discuss at: https://locutus.io/php/ini_set/
  // parity verified: PHP 8.3
  //     original by: Brett Zamir (https://brett-zamir.me)
  //          note 1: This will not set a global_value or access level for the ini item
  //       example 1: ini_set('date.timezone', 'Asia/Hong_Kong')
  //       example 1: ini_set('date.timezone', 'America/Chicago')
  //       returns 1: 'Asia/Hong_Kong'

  const runtime = ensurePhpRuntimeState()
  const entry = runtime.ini[varname] ?? (runtime.ini[varname] = {})
  const currentValue = entry.local_value
  const oldval =
    typeof currentValue === 'undefined' ? undefined : isIniEntryValue(currentValue) ? currentValue : undefined

  let normalizedValue = newvalue
  const lowerStr = String(newvalue).toLowerCase().trim()
  if (newvalue === true || lowerStr === 'on' || lowerStr === '1') {
    normalizedValue = 'on'
  }
  if (newvalue === false || lowerStr === 'off' || lowerStr === '0') {
    normalizedValue = 'off'
  }

  const setArrayValue = () => {
    // Although these are set individually, they are all accumulated.
    if (typeof entry.local_value === 'undefined') {
      entry.local_value = [normalizedValue]
      return
    }

    if (Array.isArray(entry.local_value)) {
      entry.local_value.push(normalizedValue)
      return
    }

    entry.local_value = [entry.local_value, normalizedValue]
  }

  switch (varname) {
    case 'extension':
      setArrayValue()
      break
    default:
      entry.local_value = normalizedValue
      break
  }

  return oldval
}

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