Function __global->substr_compare

Definitions

sources_custom/phpstub.php

  • Binary safe optionally case-insensitive comparison of two strings from an offset, up to length characters.
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Return: N/A

Parameters

Name Type Default Set Range Description
$main_str string required parameter N/A N/A The main string being compared
$str string required parameter N/A N/A The secondary string being compared
$offset integer required parameter N/A N/A The start position for the comparison. If negative, it starts counting from the end of the string.
$length ?integer Null N/A N/A The length of the comparison (null: the largest of the length of the str compared to the length of main_str less the offset)
$case_insensitivity boolean False N/A N/A Whether to compare as case-insensitive

Return

  • 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 (false: out of bounds)
  • Type: ~integer
  • Set: N/A
  • Range: N/A