substr.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 62126c55f1c6ed444043e7272c4f9e233818a44b Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.substr" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>substr</refname>
  <refpurpose>Возвращает подстроку</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>substr</methodname>
   <methodparam><type>string</type><parameter>string</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>
  </methodsynopsis>
  <para>
   Функция возвращает часть строки <parameter>string</parameter>.
   Начало подстроки указывают в параметре <parameter>offset</parameter>, а длину — в параметре <parameter>length</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       Входная строка.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       Если смещение <parameter>offset</parameter> неотрицательно, возвращаемая
       подстрока начинается с позиции <parameter>offset</parameter> от начала
       строки, считая с нуля. Например, в строке
       «<literal>abcdef</literal>», на позиции <literal>0</literal> находится
       символ «<literal>a</literal>», на позиции <literal>2</literal> —
       символ «<literal>c</literal>» и т. д.
      </para>
      <para>
       Если смещение <parameter>offset</parameter> отрицательно, возвращаемая
       подстрока начинается с позиции, которая отстаёт
       на <parameter>offset</parameter> символов от конца
       строки <parameter>string</parameter>.
      </para>
      <para>
       Если длина строки <parameter>string</parameter> меньше
       смещения <parameter>offset</parameter> символов, функция вернёт пустую строку.
      </para>
      <para>
       <example>
        <title>Пример с отрицательным смещением <parameter>offset</parameter></title>
        <programlisting role="php">
<![CDATA[
<?php

$rest = substr("abcdef", -1);    // Возвращает «f»
$rest = substr("abcdef", -2);    // Возвращает «ef»
$rest = substr("abcdef", -3, 1); // Возвращает «d»

?>
]]>
        </programlisting>
       </example>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Если значение <parameter>length</parameter> положительно, возвращаемая строка
       будет не длиннее <parameter>length</parameter> символов, начиная
       с параметра <parameter>offset</parameter> (в зависимости от длины
       строки <parameter>string</parameter>).
      </para>
      <para>
       Если значение параметра <parameter>length</parameter> отрицательно, будет отброшено
       заданное этим аргументом число символов с конца строки
       <parameter>string</parameter> (после вычисления
       стартовой позиции, если смещение <parameter>offset</parameter> отрицательно).
       Если при этом позиция начала
       подстроки, которую определил аргумент <parameter>offset</parameter>,
       находится в отброшенной части строки или за ней, возвращается пустая строка.
      </para>
      <para>
       Если параметр <parameter>length</parameter> задали и значение равно <literal>0</literal>,
       функция вернёт пустую строку.
      </para>
      <para>
       Если параметр <parameter>length</parameter> не указали или значение равно &null;,
       функция вернёт подстроку, которая начинается с позиции значения
       <parameter>offset</parameter> и длится до конца строки.
      </para>
      <example>
       <title>Пример с отрицательным значением параметра <parameter>length</parameter></title>
       <programlisting role="php">
<![CDATA[
<?php

$rest = substr("abcdef", 0, -1);  // Возвращает «abcde»
$rest = substr("abcdef", 2, -1);  // Возвращает «cde»
$rest = substr("abcdef", 4, -4);  // Возвращает «»; до PHP 8.0.0 возвращалось false
$rest = substr("abcdef", -3, -1); // Возвращает «de»

?>
]]>
       </programlisting>
      </example>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает извлечённую часть строки <parameter>string</parameter>
   или пустую строку.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       Параметр <parameter>length</parameter> теперь принимает значение null.
       Если значение параметра <parameter>length</parameter> явно задали как &null;,
       функция возвращает подстроку, которая заканчивается в конце строки;
       раньше возвращалась пустая строка.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       Функция возвращает пустую строку там, где раньше возвращала &false;.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Базовое использование функции <function>substr</function></title>
    <programlisting role="php">
<![CDATA[
<?php

echo substr('abcdef', 1);     // bcdef
echo substr("abcdef", 1, null); // bcdef; до PHP 8.0.0 возвращалась пустая строка
echo substr('abcdef', 1, 3);  // bcd
echo substr('abcdef', 0, 4);  // abcd
echo substr('abcdef', 0, 8);  // abcdef
echo substr('abcdef', -1, 1); // f

// Получить доступ к отдельному символу в строке
// можно также с помощью квадратных скобок
$string = 'abcdef';
echo $string[0];                 // a
echo $string[3];                 // d
echo $string[strlen($string)-1]; // f

?>
]]>
    </programlisting>
   </example>
   <example>
    <title>Функция <function>substr</function> и приведение типов</title>
    <programlisting role="php">
<![CDATA[
<?php

class apple
{
    public function __toString()
    {
        return "green";
    }
}

echo "1) ".var_export(substr("pear", 0, 2), true).PHP_EOL;
echo "2) ".var_export(substr(54321, 0, 2), true).PHP_EOL;
echo "3) ".var_export(substr(new apple(), 0, 2), true).PHP_EOL;
echo "4) ".var_export(substr(true, 0, 1), true).PHP_EOL;
echo "5) ".var_export(substr(false, 0, 1), true).PHP_EOL;
echo "6) ".var_export(substr("", 0, 1), true).PHP_EOL;
echo "7) ".var_export(substr(1.2e3, 0, 4), true).PHP_EOL;

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
1) 'pe'
2) '54'
3) 'gr'
4) '1'
5) ''
6) ''
7) '1200'
]]>
    </screen>
   </example>
   <example>
    <title>Недопустимый диапазон символов</title>
    <para>
     Если запрашивается недопустимый диапазон символов, функция <function>substr</function>
     начиная с PHP 8.0.0 возвращает пустую строку; раньше возвращалось &false;.
    </para>
    <programlisting role="php">
<![CDATA[
<?php

var_dump(substr('a', 2));

?>
]]>
   </programlisting>
   &example.outputs.8;
   <screen>
<![CDATA[
string(0) ""
]]>
   </screen>
   &example.outputs.7;
   <screen>
<![CDATA[
bool(false)
]]>
   </screen>
  </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>strrchr</function></member>
    <member><function>substr_replace</function></member>
    <member><function>preg_match</function></member>
    <member><function>trim</function></member>
    <member><function>mb_substr</function></member>
    <member><function>wordwrap</function></member>
    <member><link linkend="language.types.string.substr">Посимвольный доступ и изменение строки</link></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
-->