substr_compare() function PHP

substr_compare() function berguna untuk membandingkan sebagian dari string pertama (substring) dengan string kedua.

Syntax

int substr_compare(string $main_str, string $str, int $offset, int $length, bool $case_insensitivity)

Parameter

Parameter Penjelasan
main_str Parameter ini wajib ada. String pertama.
str Parameter ini wajib ada. String kedua.
offset Parameter ini wajib ada. Posisi batas awal sebagian dari string pertama (parameter main_str) yang ingin dibandingkan. Parameter ini memiliki beberapa pilihan, yaitu:

  • Positif. Posisi batas awal dihitung mulai dari awal string ke akhir string dengan character paling awal string adalah 0, setelahnya adalah 1 dan seterusnya sampai akhir string.
  • Negatif. Posisi batas awal dihitung mulai dari akhir string ke awal string dengan character paling akhir adalah -1, character sebelumnya adalah -2 dan seterusnya sampai awal string.
length Parameter ini pilihan. Panjang sebagian dari string pertama (parameter main_str) yang ingin dibandingkan mulai dari parameter offset. Parameter ini memiliki beberapa pilihan, yaitu:

  • Default. Jika parameter ini dikosongkan maka sebagian dari string pertama (parameter main_str) yang dibandingkan adalah mulai dari parameter offset sampai akhir string.
  • Positif. Sebagian dari string pertama (parameter main_str) yang dibandingkan adalah mulai dari parameter offset sampai sepanjang angka postif parameter length ini.

Parameter ini tidak bisa diisi dengan angka negatif.

case_insensitivity Parameter ini pilihan. Memiliki beberapa pilihan, yaitu:

  • TRUE. Function ini menjadi case insensitive atau tidak membedakan huruf besar dan kecil (ABC sama dengan abc).
  • FALSE (Default). Function ini menjadi case sensitive.

Catatan

substr_compare() function membandingkan sebagian dari string pertama (parameter main_str) mulai dari parameter offset sampai sepanjang parameter length dengan string kedua (parameter str).

substr_compare() function membandingkan string berdasarkan urutan character di dalam character set ASCII sama seperti strcmp() function.

Jika substr_compare() function berhasil dijalankan maka akan menghasilkan tiga jenis nilai, yaitu:

  • 0. Jika kedua string sama.
  • <0. Jika string pertama lebih kecil dari string kedua
  • >0. Jika string pertama lebih besar dari string kedua

Jika parameter offset memiliki panjang yang sama atau lebih besar dari panjang total string pertama (parameter main_str) maka substr_compare() function akan menghasilkan FALSE.

Jika parameter length lebih kecil dari 1 maka substr_compare() function akan menghasilkan FALSE.

substr_compare() function merupakan binary safe.

Contoh

Berikut ini adalah contoh penggunaan substr_compare() function:

Code PHP 1:

<?php
$a = substr_compare("abcde", "bc", 1, 2); 
$b = substr_compare("abcde", "de", -2, 2); 
$c = substr_compare("abcde", "bcg", 1, 2); 
$d = substr_compare("abcde", "BC", 1, 2, true); 
$e = substr_compare("abcde", "bc", 1, 3); 
$f = substr_compare("abcde", "cd", 1, 2); 

var_dump($a, $b, $c, $d, $e, $f);
?>

Hasil running code di atas bila dilihat melalui page source browser akan tampak sebagai berikut ini:

int(0)
int(0)
int(0)
int(0)
int(1)
int(-1)

Leave a Reply

Your email address will not be published. Required fields are marked *

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>