File: variant-cmp.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (145 lines) | stat: -rw-r--r-- 3,986 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
  <refentry id="function.variant-cmp">
   <refnamediv>
    <refname>variant_cmp</refname>
    <refpurpose>
     Compares two variants
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <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>
     and returns one of the following values:

     <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>

   <para>
    This function will only compare scalar values, not arrays or variant records.
   </para>

   <para>
    <parameter>lcid</parameter> is a valid Locale Identifier to use when
    comparing strings (this affects string collation).
    <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>

    &reference.com.variant-arith;
   </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:"../../../../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
-->