mirror of
https://github.com/php/doc-en.git
synced 2026-03-24 15:52:15 +01:00
873f4a3d50
* strcmp: Improve behavior description and direct users to alternative functions (strcoll and Collator::compare) where appropriate; Add the "similarity" functions to seealso Removed substr from seealso (why is it here?) * Cross-link all the string similarity functions * Trailing whitespace removal * Update reference/strings/functions/strcmp.xml Co-authored-by: Kamil Tekiela <tekiela246@gmail.com> * strcmp: Improve behavior description and direct users to alternative functions (strcoll and Collator::compare) where appropriate --------- Co-authored-by: Kamil Tekiela <tekiela246@gmail.com>
147 lines
3.7 KiB
XML
147 lines
3.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.strcmp" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>strcmp</refname>
|
|
<refpurpose>Binary safe string comparison</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>strcmp</methodname>
|
|
<methodparam><type>string</type><parameter>string1</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>string2</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<simpara>
|
|
Note that this comparison is case sensitive. For case-insensitive comparison,
|
|
see <function>strcasecmp</function>.
|
|
</simpara>
|
|
<simpara>
|
|
Note that this comparison is not locale aware. For locale aware comparison see
|
|
<function>strcoll</function> or <methodname>Collator::compare</methodname>
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>string1</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The first string.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>string2</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The second string.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
&strings.comparison.return;
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
&standard.changelog.binary-safe-string-comparison;
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>strcmp</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$var1 = "Hello";
|
|
$var2 = "hello";
|
|
if (strcmp($var1, $var2) !== 0) {
|
|
echo '$var1 is not equal to $var2 in a case sensitive string comparison';
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>Full string comparison</simpara>
|
|
<simplelist>
|
|
<member><function>strcasecmp</function></member>
|
|
<member><methodname>Collator::compare</methodname></member>
|
|
<member><function>strcoll</function></member>
|
|
</simplelist>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>Partial string comparison</simpara>
|
|
<simplelist>
|
|
<member><function>substr_compare</function></member>
|
|
<member><function>strncmp</function></member>
|
|
<member><function>strstr</function></member>
|
|
</simplelist>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>Similar / other string comparison</simpara>
|
|
<simplelist>
|
|
<member><function>preg_match</function></member>
|
|
<member><function>levenshtein</function></member>
|
|
<member><function>metaphone</function></member>
|
|
<member><function>similar_text</function></member>
|
|
<member><function>soundex</function></member>
|
|
</simplelist>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</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
|
|
-->
|