PHP's strtok in TypeScript

How to use

Install via yarn add locutus and import: import { strtok } from 'locutus/php/strings/strtok'.

Or with CommonJS: const { strtok } = require('locutus/php/strings/strtok')

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	var $string = "\t\t\t\nThis is\tan example\nstring\n" var $tok = strtok($string, " \n\t") var $b = '' while ($tok !== false) {$b += "Word="+$tok+"\n"; $tok = strtok(" \n\t");} var $result = $b	"Word=This\nWord=is\nWord=an\nWord=example\nWord=string\n"

Notes

• Use tab and newline as tokenizing characters as well

Dependencies

This function uses the following Locutus functions:

• _phpRuntimeState (php/_helpers)

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

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

export function strtok(str: string, tokens?: string): string | false {
  //  discuss at: https://locutus.io/php/strtok/
  // original by: Brett Zamir (https://brett-zamir.me)
  //      note 1: Use tab and newline as tokenizing characters as well
  //   example 1: var $string = "\t\t\t\nThis is\tan example\nstring\n"
  //   example 1: var $tok = strtok($string, " \n\t")
  //   example 1: var $b = ''
  //   example 1: while ($tok !== false) {$b += "Word="+$tok+"\n"; $tok = strtok(" \n\t");}
  //   example 1: var $result = $b
  //   returns 1: "Word=This\nWord=is\nWord=an\nWord=example\nWord=string\n"

  if (typeof tokens === 'undefined') {
    tokens = str
    str = getPhpRuntimeString('strtokleftOver', '')
  }
  if (str.length === 0) {
    return false
  }
  if (tokens.includes(str.charAt(0))) {
    return strtok(str.substring(1), tokens)
  }
  let i = 0
  for (; i < str.length; i++) {
    if (tokens.includes(str.charAt(i))) {
      break
    }
  }
  setPhpRuntimeEntry('strtokleftOver', str.substring(i + 1))

  return str.substring(0, i)
}

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

export function strtok(str, tokens) {
  //  discuss at: https://locutus.io/php/strtok/
  // original by: Brett Zamir (https://brett-zamir.me)
  //      note 1: Use tab and newline as tokenizing characters as well
  //   example 1: var $string = "\t\t\t\nThis is\tan example\nstring\n"
  //   example 1: var $tok = strtok($string, " \n\t")
  //   example 1: var $b = ''
  //   example 1: while ($tok !== false) {$b += "Word="+$tok+"\n"; $tok = strtok(" \n\t");}
  //   example 1: var $result = $b
  //   returns 1: "Word=This\nWord=is\nWord=an\nWord=example\nWord=string\n"

  if (typeof tokens === 'undefined') {
    tokens = str
    str = getPhpRuntimeString('strtokleftOver', '')
  }
  if (str.length === 0) {
    return false
  }
  if (tokens.includes(str.charAt(0))) {
    return strtok(str.substring(1), tokens)
  }
  let i = 0
  for (; i < str.length; i++) {
    if (tokens.includes(str.charAt(i))) {
      break
    }
  }
  setPhpRuntimeEntry('strtokleftOver', str.substring(i + 1))

  return str.substring(0, i)
}

// 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 PhpRuntimeStringKey = {
  [K in keyof PhpRuntimeKnownEntryMap]: PhpRuntimeKnownEntryMap[K] extends string ? 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 getPhpRuntimeString(key: PhpRuntimeStringKey, fallback: string): string

function getPhpRuntimeString(key: string, fallback: string): string

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

// php/strings/strtok (target function module)
function strtok(str: string, tokens?: string): string | false {
  //  discuss at: https://locutus.io/php/strtok/
  // original by: Brett Zamir (https://brett-zamir.me)
  //      note 1: Use tab and newline as tokenizing characters as well
  //   example 1: var $string = "\t\t\t\nThis is\tan example\nstring\n"
  //   example 1: var $tok = strtok($string, " \n\t")
  //   example 1: var $b = ''
  //   example 1: while ($tok !== false) {$b += "Word="+$tok+"\n"; $tok = strtok(" \n\t");}
  //   example 1: var $result = $b
  //   returns 1: "Word=This\nWord=is\nWord=an\nWord=example\nWord=string\n"

  if (typeof tokens === 'undefined') {
    tokens = str
    str = getPhpRuntimeString('strtokleftOver', '')
  }
  if (str.length === 0) {
    return false
  }
  if (tokens.includes(str.charAt(0))) {
    return strtok(str.substring(1), tokens)
  }
  let i = 0
  for (; i < str.length; i++) {
    if (tokens.includes(str.charAt(i))) {
      break
    }
  }
  setPhpRuntimeEntry('strtokleftOver', str.substring(i + 1))

  return str.substring(0, i)
}

// 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 getPhpRuntimeString(key, fallback) {
  const value = getPhpRuntimeEntry(key)
  return typeof value === 'string' ? value : fallback
}

// php/strings/strtok (target function module)
function strtok(str, tokens) {
  //  discuss at: https://locutus.io/php/strtok/
  // original by: Brett Zamir (https://brett-zamir.me)
  //      note 1: Use tab and newline as tokenizing characters as well
  //   example 1: var $string = "\t\t\t\nThis is\tan example\nstring\n"
  //   example 1: var $tok = strtok($string, " \n\t")
  //   example 1: var $b = ''
  //   example 1: while ($tok !== false) {$b += "Word="+$tok+"\n"; $tok = strtok(" \n\t");}
  //   example 1: var $result = $b
  //   returns 1: "Word=This\nWord=is\nWord=an\nWord=example\nWord=string\n"

  if (typeof tokens === 'undefined') {
    tokens = str
    str = getPhpRuntimeString('strtokleftOver', '')
  }
  if (str.length === 0) {
    return false
  }
  if (tokens.includes(str.charAt(0))) {
    return strtok(str.substring(1), tokens)
  }
  let i = 0
  for (; i < str.length; i++) {
    if (tokens.includes(str.charAt(i))) {
      break
    }
  }
  setPhpRuntimeEntry('strtokleftOver', str.substring(i + 1))

  return str.substring(0, i)
}

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

Star