<?xml version="1.0" encoding="utf-8"?>

<!-- EN-Revision: 45042fef652f1b4e904e809fcbfcf31f6c60670b Maintainer: shein Status: ready -->

<!-- Reviewed: no -->

<refentry xml:id="function.substr-compare" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>substr_compare</refname>

<refpurpose>Сравнивает две строки со смещения до заданного количества символов в бинарно безопасном режиме</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>int</type><methodname>substr_compare</methodname>

<methodparam><type>string</type><parameter>haystack</parameter></methodparam>

<methodparam><type>string</type><parameter>needle</parameter></methodparam>

<methodparam><type>int</type><parameter>offset</parameter></methodparam>

<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>

<methodparam choice="opt"><type>bool</type><parameter>case_insensitive</parameter><initializer>&false;</initializer></methodparam>

</methodsynopsis>

<para>

Функция <function>substr_compare</function> сравнивает часть строки <parameter>haystack</parameter>

с подстрокой <parameter>needle</parameter>.

Параметр <parameter>offset</parameter> определяет, какую часть строки сравнивает функция,

а параметр <parameter>length</parameter> — количество символов для сравнения.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>haystack</parameter></term>

<listitem>

<para>

Главная строка для сравнения.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>needle</parameter></term>

<listitem>

<para>

Вторая строка для сравнения.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>offset</parameter></term>

<listitem>

<para>

Стартовая позиция сравнения. При отрицательном значении

функция отсчитывает позицию смещения с конца строки.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>length</parameter></term>

<listitem>

<para>

Длина сравнения. Значение по умолчанию равно размеру наибольшей по длине строки:

<parameter>needle</parameter> или <parameter>haystack</parameter>

за вычетом абсолютного количества байтов смещения <parameter>offset</parameter>.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>case_insensitive</parameter></term>

<listitem>

<para>

При установке для параметра <parameter>case_insensitive</parameter> значения &true;

сравнение выполняется без учёта регистра.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

&strings.comparison.return;

<para>

Функция <function>substr_compare</function> выводит предупреждение и возвращает &false;,

если параметр <parameter>offset</parameter> больше (до PHP 7.2.18, 7.3.5) или равен длине

параметра <parameter>haystack</parameter>, или если установили для параметра <parameter>length</parameter>

значение меньше 0.

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<para>

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

&standard.changelog.binary-safe-string-comparison;

<row>

<entry>8.0.0</entry>

<entry>

Параметр <parameter>length</parameter> теперь принимает значение &null;.

</entry>

</row>

<row>

<entry>7.2.18, 7.3.5</entry>

<entry>

Параметр <parameter>offset</parameter> теперь может равняться параметру <parameter>haystack</parameter>.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Пример сравнения строк функцией <function>substr_compare</function></title>

<programlisting role="php">

<![CDATA[

<?php

echo substr_compare("abcde", "bc", 1, 2), PHP_EOL; // 0

echo substr_compare("abcde", "de", -2, 2), PHP_EOL; // 0

echo substr_compare("abcde", "bcg", 1, 2), PHP_EOL; // 0

echo substr_compare("abcde", "BC", 1, 2, true), PHP_EOL; // 0

echo substr_compare("abcde", "bc", 1, 3), PHP_EOL; // 1

echo substr_compare("abcde", "cd", 1, 2), PHP_EOL; // -1

echo substr_compare("abcde", "abc", 5, 1), PHP_EOL; // -1

?>

]]>

</programlisting>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>strncmp</function></member>

</simplelist>

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

-->