substr_compare

(PHP 5)

substr_compare指定した位置から指定した長さの 2 つの文字列について、バイナリ対応で比較する

説明

int substr_compare ( string $main_str , string $str , int $offset [, int $length [, bool $case_insensitivity = false ]] )

substr_compare() は、main_stroffset 文字目以降の最大 length 文字を、str と比較します。

パラメータ

main_str

比較したい最初の文字列。

str

比較したい二番目の文字列。

offset

比較を開始する位置。 負の値を指定した場合は、文字列の最後から数えます。

length

比較する長さ。デフォルト値は、 main_str の長さから offset を引いたものと str の長さのうち、長いほうです。

case_insensitivity

case_insensitivityTRUE の場合、 大文字小文字を区別せずに比較します。

返り値

main_stroffset 以降が str より小さい場合に負の数、 str より大きい場合に正の数、 等しい場合に 0 を返します。offsetmain_str の長さ以上であるか、あるいは length が設定されていて 1 未満である場合、substr_compare() は警告を表示して FALSE を返します。

変更履歴

バージョン 説明
5.1.0 負の offset を使用できるようになりました。

例1 substr_compare() の例

<?php
echo substr_compare("abcde""bc"12); // 0
echo substr_compare("abcde""de", -22); // 0
echo substr_compare("abcde""bcg"12); // 0
echo substr_compare("abcde""BC"12true); // 0
echo substr_compare("abcde""bc"13); // 1
echo substr_compare("abcde""cd"12); // -1
echo substr_compare("abcde""abc"51); // 警告
?>

参考

  • strncmp() - 最初の n 文字についてバイナリセーフな文字列比較を行う

add a note add a note

User Contributed Notes 3 notes

up
5
jimmetry at gmail dot com
1 year ago
When you came to this page, you may have been looking for something a little simpler: A function that can check if a small string exists within a larger string starting at a particular index. Using substr_compare() for this can leave your code messy, because you need to check that your string is long enough (to avoid the warning), manually specify the length of the short string, and like many of the string functions, perform an integer comparison to answer a true/false question.

I put together a simple function to return true if $str exists within $mainStr. If $loc is specified, the $str must begin at that index. If not, the entire $mainStr will be searched.

<?php

function contains_substr($mainStr, $str, $loc = false) {
    if (
$loc === false) return (strpos($mainStr, $str) !== false);
    if (
strlen($mainStr) < strlen($str)) return false;
    if ((
$loc + strlen($str)) > strlen($mainStr)) return false;
    return (
strcmp(substr($mainStr, $loc, strlen($str)), $str) == 0);
}

?>
up
0
Skyborne
1 year ago
Take note of the `length` parameter: "The default value is the largest of the length of the str compared to the length of main_str less the offset."

This is *not* the length of str as you might (I always) expect, so if you leave it out, you'll get unexpected results.  Example:

<?php
$hash
= '$5$lalalalalalalala$crypt.output.here';
var_dump(substr_compare($hash, '$5$', 0)); # int(34)
var_dump(substr_compare($hash, '$5$', 0, 3)); # int(0)
var_dump(PHP_VERSION); # string(6) "5.3.14"
?>
up
-2
sleek
8 years ago
Modified version of the original posted function. Use this one:

<?php
if (!function_exists('substr_compare')) {
    function
substr_compare($main_str, $str, $offset, $length = NULL, $case_insensitivity = false) {
       
$offset = (int) $offset;

       
// Throw a warning because the offset is invalid
       
if ($offset >= strlen($main_str)) {
           
trigger_error('The start position cannot exceed initial string length.', E_USER_WARNING);
            return
false;
        }

       
// We are comparing the first n-characters of each string, so let's use the PHP function to do it
       
if ($offset == 0 && is_int($length) && $case_insensitivity === true) {
            return
strncasecmp($main_str, $str, $length);
        }

       
// Get the substring that we are comparing
       
if (is_int($length)) {
           
$main_substr = substr($main_str, $offset, $length);
           
$str_substr = substr($str, 0, $length);
        } else {
           
$main_substr = substr($main_str, $offset);
           
$str_substr = $str;
        }

       
// Return a case-insensitive comparison of the two strings
       
if ($case_insensitivity === true) {
            return
strcasecmp($main_substr, $str_substr);
        }

       
// Return a case-sensitive comparison of the two strings
       
return strcmp($main_substr, $str_substr);
    }
}
?>
To Top