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
|
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.substr-compare">
<refnamediv>
<refname>substr_compare</refname>
<refpurpose>
Binary safe optionally case insensitive comparison of 2 strings from an offset, up to length characters
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>substr_compare</methodname>
<methodparam><type>string</type><parameter>main_str</parameter></methodparam>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>case_insensitivity</parameter></methodparam>
</methodsynopsis>
<para>
<function>substr_compare</function> compares <parameter>main_str</parameter>
from position <parameter>offset</parameter> with <parameter>str</parameter>
up to <parameter>length</parameter> characters.
</para>
<para>
Returns < 0 if <parameter>main_str</parameter> from position
<parameter>offset</parameter> is less than <parameter>str</parameter>, >
0 if it is greater than <parameter>str</parameter>, and 0 if they are equal.
If <parameter>length</parameter> is equal or greater than length of
<parameter>main_str</parameter> and <parameter>length</parameter> is set,
<function>substr_compare</function> prints warning and returns &false;.
</para>
<para>
If <parameter>case_insensitivity</parameter> is &true;, comparison is case
insensitive.
</para>
<para>
<example>
<title>A <function>substr_compare</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
echo substr_compare("abcde", "bc", 1, 2); // 0
echo substr_compare("abcde", "bcg", 1, 2); // 0
echo substr_compare("abcde", "BC", 1, 2, true); // 0
echo substr_compare("abcde", "bc", 1, 3); // 1
echo substr_compare("abcde", "cd", 1, 2); // -1
echo substr_compare("abcde", "abc", 5, 1); // warning
?>
]]>
</programlisting>
</example>
</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:"../../../../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
-->
|
