PHP's set_time_limit in TypeScript

How to use

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

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

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	set_time_limit(4)	undefined

Dependencies

This function uses the following Locutus functions:

• _phpRuntimeState (php/_helpers)

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

import { getPhpRuntimeBoolean, setPhpRuntimeEntry } from '../_helpers/_phpRuntimeState.ts'

export function set_time_limit(seconds: number): void {
  //  discuss at: https://locutus.io/php/set_time_limit/
  // original by: Brett Zamir (https://brett-zamir.me)
  //        test: skip-all
  //   example 1: set_time_limit(4)
  //   returns 1: undefined

  setTimeout(function () {
    if (!getPhpRuntimeBoolean('timeoutStatus', false)) {
      setPhpRuntimeEntry('timeoutStatus', true)
    }
    throw new Error('Maximum execution time exceeded')
  }, seconds * 1000)
}

import { getPhpRuntimeBoolean, setPhpRuntimeEntry } from '../_helpers/_phpRuntimeState.ts'

export function set_time_limit(seconds) {
  //  discuss at: https://locutus.io/php/set_time_limit/
  // original by: Brett Zamir (https://brett-zamir.me)
  //        test: skip-all
  //   example 1: set_time_limit(4)
  //   returns 1: undefined

  setTimeout(function () {
    if (!getPhpRuntimeBoolean('timeoutStatus', false)) {
      setPhpRuntimeEntry('timeoutStatus', true)
    }
    throw new Error('Maximum execution time exceeded')
  }, seconds * 1000)
}

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

type PhpInput = {} | PhpNullish

type PhpList<T = PhpInput> = T[]

type PhpAssoc<T = PhpInput> = { [key: string]: T }

// 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>
}

interface PhpRuntimeKnownEntryMap {
  ini: PhpAssoc<IniEntry | undefined>
  locales: PhpAssoc<LocaleEntry | undefined>
  localeCategories: LocaleCategoryMap
  pointers: PhpList<PhpInput>
  locale_default: string
  locale: string
  uniqidSeed: number
  timeoutStatus: boolean
  last_error_json: number
  strtokleftOver: string
}

type PhpRuntimeBooleanKey = {
  [K in keyof PhpRuntimeKnownEntryMap]: PhpRuntimeKnownEntryMap[K] extends boolean ? K : never
}[keyof PhpRuntimeKnownEntryMap]

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

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 getPhpRuntimeEntry<TKey extends keyof PhpRuntimeKnownEntryMap>(
  key: TKey,
): PhpRuntimeKnownEntryMap[TKey] | undefined

function getPhpRuntimeEntry(key: string): PhpInput | undefined

function getPhpRuntimeEntry(key: string): PhpInput | undefined {
  const php = ensurePhpRuntimeObject()
  const value = php[key]
  return typeof value === 'undefined' ? undefined : value
}

function setPhpRuntimeEntry<TKey extends keyof PhpRuntimeKnownEntryMap>(
  key: TKey,
  value: PhpRuntimeKnownEntryMap[TKey],
): void

function setPhpRuntimeEntry(key: string, value: PhpInput): void

function setPhpRuntimeEntry(key: string, value: PhpInput): void {
  const php = ensurePhpRuntimeObject()
  php[key] = value
}

function getPhpRuntimeBoolean(key: PhpRuntimeBooleanKey, fallback: boolean): boolean

function getPhpRuntimeBoolean(key: string, fallback: boolean): boolean

function getPhpRuntimeBoolean(key: string, fallback: boolean): boolean {
  const value = getPhpRuntimeEntry(key)
  return typeof value === 'boolean' ? value : fallback
}

// php/info/set_time_limit (target function module)
function set_time_limit(seconds: number): void {
  //  discuss at: https://locutus.io/php/set_time_limit/
  // original by: Brett Zamir (https://brett-zamir.me)
  //        test: skip-all
  //   example 1: set_time_limit(4)
  //   returns 1: undefined

  setTimeout(function () {
    if (!getPhpRuntimeBoolean('timeoutStatus', false)) {
      setPhpRuntimeEntry('timeoutStatus', true)
    }
    throw new Error('Maximum execution time exceeded')
  }, seconds * 1000)
}

// 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 getPhpRuntimeEntry(key) {
  const php = ensurePhpRuntimeObject()
  const value = php[key]
  return typeof value === 'undefined' ? undefined : value
}

function setPhpRuntimeEntry(key, value) {
  const php = ensurePhpRuntimeObject()
  php[key] = value
}

function getPhpRuntimeBoolean(key, fallback) {
  const value = getPhpRuntimeEntry(key)
  return typeof value === 'boolean' ? value : fallback
}

// php/info/set_time_limit (target function module)
function set_time_limit(seconds) {
  //  discuss at: https://locutus.io/php/set_time_limit/
  // original by: Brett Zamir (https://brett-zamir.me)
  //        test: skip-all
  //   example 1: set_time_limit(4)
  //   returns 1: undefined

  setTimeout(function () {
    if (!getPhpRuntimeBoolean('timeoutStatus', false)) {
      setPhpRuntimeEntry('timeoutStatus', true)
    }
    throw new Error('Maximum execution time exceeded')
  }, seconds * 1000)
}

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