substr_compare()
substr_compare - Binary safe comparison of two strings from an offset, up to length characters
Syntax
int substr_compare (
string $main_str,
string $str,
int $offset,
int $length,
bool $case_insensitivity)
Arguments
- main_str - The main string being compared.
- str - The secondary string being compared.
- offset - The start position for the comparison. If negative, it starts counting from the end of the string.
- length - The length of the comparison. The default value is the largest of the length of the str compared to the length of main_str less the offset.
- case_insensitivity - If case_insensitivity is TRUE, comparison is case insensitive.
Description
substr_compare() compares main_str from position offset with str up to length characters.
Version
PHP 5
Return value
Returns < 0 if main_str from position offset is less than str, > 0 if it is greater than str, and 0 if they are equal. If offset is equal to or greater than the length of main_str or length is set and is less than 1, substr_compare() prints a warning and returns FALSE.
