PHP's str_ireplace in TypeScript

How to use

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

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

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	str_ireplace('M', 'e', 'name')	'naee'
2	var $countObj = {} str_ireplace('M', 'e', 'name', $countObj) var $result = $countObj.value	1
3	str_ireplace('', '.', 'aaa')	'aaa'

Notes

• Case-insensitive version of str_replace() Compliant with PHP 5.0 str_ireplace() Full details at: https://ca3.php.net/manual/en/function.str-ireplace.php

• The countObj parameter (optional) if used must be passed in as a object. The count will then be written by reference into it’s value property

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

type CountObj = { value?: number }
const asArray = (value: string | string[]): string[] => (Array.isArray(value) ? [...value] : [value])

export function str_ireplace(
  search: string | string[],
  replace: string | string[],
  subject: string | string[],
  countObj?: CountObj,
): string | string[] {
  //  discuss at: https://locutus.io/php/str_ireplace/
  // original by: Glen Arason (https://CanadianDomainRegistry.ca)
  // bugfixed by: Mahmoud Saeed
  //      note 1: Case-insensitive version of str_replace()
  //      note 1: Compliant with PHP 5.0 str_ireplace() Full details at:
  //      note 1: https://ca3.php.net/manual/en/function.str-ireplace.php
  //      note 2: The countObj parameter (optional) if used must be passed in as a
  //      note 2: object. The count will then be written by reference into it's `value` property
  //   example 1: str_ireplace('M', 'e', 'name')
  //   returns 1: 'naee'
  //   example 2: var $countObj = {}
  //   example 2: str_ireplace('M', 'e', 'name', $countObj)
  //   example 2: var $result = $countObj.value
  //   returns 2: 1
  //   example 3: str_ireplace('', '.', 'aaa')
  //   returns 3: 'aaa'

  const loweredSearch = Array.isArray(search) ? search.map((item) => item.toLowerCase()) : search.toLowerCase()
  const loweredSubject = Array.isArray(subject) ? subject.map((item) => item.toLowerCase()) : subject.toLowerCase()
  const osa = Array.isArray(subject)
  const f = asArray(loweredSearch)
  const s = asArray(loweredSubject)
  const os = asArray(subject)
  let r = asArray(replace)

  if (Array.isArray(loweredSearch) && typeof replace === 'string') {
    r = loweredSearch.map(() => replace)
  }

  if (countObj) {
    countObj.value = 0
  }

  for (let i = 0, sl = s.length; i < sl; i++) {
    if (s[i] === '') {
      continue
    }
    for (let j = 0, fl = f.length; j < fl; j++) {
      const searchTerm = f[j] ?? ''
      if (searchTerm === '') {
        continue
      }
      const temp = s[i] ?? ''
      const repl = r[j] ?? ''
      s[i] = temp.split(searchTerm).join(repl)
      const otemp = os[i] ?? ''
      const oi = temp.indexOf(searchTerm)
      const ofjl = searchTerm.length
      if (oi >= 0) {
        os[i] = otemp.split(otemp.substr(oi, ofjl)).join(repl)
      }

      if (countObj) {
        countObj.value = (countObj.value ?? 0) + temp.split(searchTerm).length - 1
      }
    }
  }

  return osa ? os : (os[0] ?? '')
}

const asArray = (value) => (Array.isArray(value) ? [...value] : [value])

export function str_ireplace(search, replace, subject, countObj) {
  //  discuss at: https://locutus.io/php/str_ireplace/
  // original by: Glen Arason (https://CanadianDomainRegistry.ca)
  // bugfixed by: Mahmoud Saeed
  //      note 1: Case-insensitive version of str_replace()
  //      note 1: Compliant with PHP 5.0 str_ireplace() Full details at:
  //      note 1: https://ca3.php.net/manual/en/function.str-ireplace.php
  //      note 2: The countObj parameter (optional) if used must be passed in as a
  //      note 2: object. The count will then be written by reference into it's `value` property
  //   example 1: str_ireplace('M', 'e', 'name')
  //   returns 1: 'naee'
  //   example 2: var $countObj = {}
  //   example 2: str_ireplace('M', 'e', 'name', $countObj)
  //   example 2: var $result = $countObj.value
  //   returns 2: 1
  //   example 3: str_ireplace('', '.', 'aaa')
  //   returns 3: 'aaa'

  const loweredSearch = Array.isArray(search) ? search.map((item) => item.toLowerCase()) : search.toLowerCase()
  const loweredSubject = Array.isArray(subject) ? subject.map((item) => item.toLowerCase()) : subject.toLowerCase()
  const osa = Array.isArray(subject)
  const f = asArray(loweredSearch)
  const s = asArray(loweredSubject)
  const os = asArray(subject)
  let r = asArray(replace)

  if (Array.isArray(loweredSearch) && typeof replace === 'string') {
    r = loweredSearch.map(() => replace)
  }

  if (countObj) {
    countObj.value = 0
  }

  for (let i = 0, sl = s.length; i < sl; i++) {
    if (s[i] === '') {
      continue
    }
    for (let j = 0, fl = f.length; j < fl; j++) {
      const searchTerm = f[j] ?? ''
      if (searchTerm === '') {
        continue
      }
      const temp = s[i] ?? ''
      const repl = r[j] ?? ''
      s[i] = temp.split(searchTerm).join(repl)
      const otemp = os[i] ?? ''
      const oi = temp.indexOf(searchTerm)
      const ofjl = searchTerm.length
      if (oi >= 0) {
        os[i] = otemp.split(otemp.substr(oi, ofjl)).join(repl)
      }

      if (countObj) {
        countObj.value = (countObj.value ?? 0) + temp.split(searchTerm).length - 1
      }
    }
  }

  return osa ? os : (os[0] ?? '')
}

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