substr_compare

(PHP 5, PHP 7)

substr_compareBinärdaten-sicherer Vergleich zweier Strings, beginnend an einer bestimmten Position und endend nach einer festgelegten Länge

Beschreibung

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

substr_compare() vergleicht main_str ab der in offset definierten Position mit str. Die Länge des verglichenen String-Bestandteils wird vom length-Parameter bestimmt.

Parameter-Liste

main_str

Die zu vergleichende Hauptzeichenkette.

str

Die zweite zu vergleichende Zeichenkette.

offset

Die Anfangsposition für den Vergleich. Wenn der Wert negativ ist, wird rückwärts vom Ende der Zeichenkette an gezählt. The start position for the comparison. If negative, it starts counting from the end of the string.

length

Die Länge der zu vergleichenden Zeichensequenz. Standardwert ist der größere Wert des Vergleiches der Länge des str mit der Länge von main_str minus offset.

case_insensitivity

Wenn case_insensitivity den Wert TRUE hat, wird der Vergleich ohne Berücksichtigung der Groß- und Kleinschreibung durchgeführt.

Rückgabewerte

Gibt eine Zahl < 0 zurück, wenn main_str ab der in offset festgelegten Position kürzer ist als str, eine Zahl > 0, wenn der ermittelte String länger ist als str, und 0, wenn sie gleich sind. Wenn der Parameter offset gesetzt und gleich oder größer als die Länge von main_str ist oder length gesetzt und kleiner als 1 ist (vor PHP 5.5.11), gibt substr_compare() eine Warnung aus und hat den Rückgabewert FALSE.

Changelog

Version Beschreibung
5.5.11 length kann nun 0 sein.
5.1.0 Die Möglichkeit, einen negativen Wert für offset festzulegen, wurde eingeführt.

Beispiele

Beispiel #1 Ein substr_compare()-Beispiel

<?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); // warning
?>

Siehe auch

  • strncmp() - String-Vergleich der ersten n Zeichen (Binary safe)