mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 10:58:54 +00:00
2fd3f0c96d
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297078 c90b9560-bf6c-de11-be94-00142212c4b1
167 lines
4.6 KiB
XML
167 lines
4.6 KiB
XML
<?xml version='1.0' encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.variant-cmp" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>variant_cmp</refname>
|
|
<refpurpose>Compares two variants</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>variant_cmp</methodname>
|
|
<methodparam><type>mixed</type><parameter>left</parameter></methodparam>
|
|
<methodparam><type>mixed</type><parameter>right</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>lcid</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Compares <parameter>left</parameter> with <parameter>right</parameter>.
|
|
</para>
|
|
<para>
|
|
This function will only compare scalar values, not arrays or variant records.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>left</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The left operand.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>right</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The right operand.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>lcid</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A valid Locale Identifier to use when comparing strings (this affects
|
|
string collation).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>flags</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<parameter>flags</parameter> can be one or more of the following values
|
|
OR'd together, and affects string comparisons:
|
|
<table>
|
|
<title>Variant Comparision Flags</title>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>value</entry>
|
|
<entry>meaning</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry><constant>NORM_IGNORECASE</constant></entry>
|
|
<entry>Compare case insensitively</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>NORM_IGNORENONSPACE</constant></entry>
|
|
<entry>Ignore nonspacing characters</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>NORM_IGNORESYMBOLS</constant></entry>
|
|
<entry>Ignore symbols</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>NORM_IGNOREWIDTH</constant></entry>
|
|
<entry>Ignore string width</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>NORM_IGNOREKANATYPE</constant></entry>
|
|
<entry>Ignore Kana type</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>NORM_IGNOREKASHIDA</constant></entry>
|
|
<entry>Ignore Arabic kashida characters</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
&com.variant-arith;
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns one of the following:
|
|
<table>
|
|
<title>Variant Comparision Results</title>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>value</entry>
|
|
<entry>meaning</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry><constant>VARCMP_LT</constant></entry>
|
|
<entry><parameter>left</parameter> is less than
|
|
<parameter>right</parameter>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>VARCMP_EQ</constant></entry>
|
|
<entry><parameter>left</parameter> is equal to
|
|
<parameter>right</parameter>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>VARCMP_GT</constant></entry>
|
|
<entry><parameter>left</parameter> is greater than
|
|
<parameter>right</parameter>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>VARCMP_NULL</constant></entry>
|
|
<entry>Either <parameter>left</parameter>,
|
|
<parameter>right</parameter> or both are &null;
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|