DocumentationHSLReferenceFunctionHH\Lib\Str\compare

HH\Lib\Str\compare

Meta Engineer?

This is available as Str\compare in the www repository.

Returns < 0 if $string1 is less than $string2, > 0 if $string1 is greater than $string2, and 0 if they are equal

namespace HH\Lib\Str;

function compare(
  string $string1,
  string $string2,
): int;

For a case-insensitive comparison, see Str\compare_ci().

Guide

String

Parameters

string $string1
string $string2

Returns

int

Examples

$comparison_1 = Str\compare("apple", "banana");
echo "Result of first comparison: $comparison_1 \n";

$comparison_2 = Str\compare("banana", "apple");
echo "Result of second comparison: $comparison_2 \n";

$comparison_3 = Str\compare("apple", "apple");
echo "Result of third comparison: $comparison_3 \n";

$comparison_4 = Str\compare("apple", "Apple");
echo "Result of fourth comparison: $comparison_4 \n";