variant_cmp

(PHP 5, PHP 7, PHP 8)

variant_cmp — Compares two variants

Beschreibung

variant_cmp(
    mixed $left,
    mixed $right,
    int $locale_id = LOCALE_SYSTEM_DEFAULT,
    int $flags = 0
): int

Compares left with right.

This function will only compare scalar values, not arrays or variant records.

Parameter-Liste

left

The left operand.

right

The right operand.

locale_id

A valid Locale Identifier to use when comparing strings (this affects string collation).

flags

flags can be one or more of the following values OR'd together, and affects string comparisons:

**Variant Comparision Flags**
value	meaning
`NORM_IGNORECASE`	Compare case insensitively
`NORM_IGNORENONSPACE`	Ignore nonspacing characters
`NORM_IGNORESYMBOLS`	Ignore symbols
`NORM_IGNOREWIDTH`	Ignore string width
`NORM_IGNOREKANATYPE`	Ignore Kana type
`NORM_IGNOREKASHIDA`	Ignore Arabic kashida characters

Hinweis:
Wie bei allen arithmetischen Variantfunktionen, können die Parameter dieser Funktion entweder native PHP-Typen (Integer, String, Fließkomma, Boolean oder null) oder Instanzen einer COM-, VARIANT- oder DOTNET-Klasse sein. Native PHP-Typen werden nach den gleichen Regeln in Varianten umgewandelt wie auch im Konstruktor der variant-Klasse. Für COM- und DOTNET-Objekte wird der Wert ihrer Standardeigenschaft genommen und als Variantenwert genutzt.

Die arithmetischen Variantenfunktionen sind Wrapper für die ähnlich benannten Funktionen der COM-Bibliothek, weiterführende Informationen hierzu finden sie in der MSDN-Bibliothek. Die PHP-Funktionen sind leicht abweichend benannt, so korrespondiert variant_add() in PHP zu VarAdd() in der MSDN-Dokumentation.

Rückgabewerte

Returns one of the following:

**Variant Comparision Results**
value	meaning
`VARCMP_LT`	`left` is less than `right`
`VARCMP_EQ`	`left` is equal to `right`
`VARCMP_GT`	`left` is greater than `right`
`VARCMP_NULL`	Either `left`, `right` or both are `null`