archived-doc-ru/reference/mbstring/functions/mb-strcut.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 92f1b8b177eb5730382abf9f27bae868f1bb636f Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.mb-strcut" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>mb_strcut</refname>
  <refpurpose>Получает часть строки</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>mb_strcut</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam><type>int</type><parameter>start</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 class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Функция <function>mb_strcut</function> вырезает подстроку из строки так же, как
   функция <function>mb_substr</function>, но оперирует байтами, а не символами. Если
   начало вырезаемой части попадает между байтами одного символа, функция вырежет
   подстроку, начиная с первого байта этого символа. Это существенное отличие
   от функции <function>substr</function>, которая просто вырежет подстроку, начиная с
   середины символа, и этим нарушит последовательность байтов в строке.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       Обрезаемая строка.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>start</parameter></term>
     <listitem>
      <para>
       Если значение параметра <parameter>start</parameter> неотрицательное, возвращённая строка
       начнётся с позиции <parameter>start</parameter> в <emphasis>байтах</emphasis>
       от начала строки <parameter>string</parameter>, считая с нуля.
       Например, в строке «<literal>abcdef</literal>» байт в позиции <literal>0</literal> — это
       «<literal>a</literal>», байт в позиции <literal>2</literal> — «<literal>c</literal>» и т. д.
      </para>
      <para>
       Если значение параметра <parameter>start</parameter> отрицательное, возвращаемая строка
       будет начинаться с байта <parameter>start</parameter>
       с обратным отсчётом от конца строки <parameter>string</parameter>. Однако, если
       величина отрицательного <parameter>start</parameter> превышает
       длину строки, возвращаемая часть начнётся с начала
       параметра <parameter>string</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Длина подстроки <emphasis>в байтах</emphasis>. Если не указана, то
       передаётся значение <literal>NULL</literal> и вырезаются все байты до конца строки.
      </para>
      <para>
       Если значение параметра <parameter>length</parameter> отрицательное, возвращаемая строка будет
       заканчиваться байтом <parameter>length</parameter> с обратным отсчётом от
       конца строки <parameter>string</parameter>. Однако, если величина отрицательного значения
       <parameter>length</parameter> превышает число символов
       после позиции <parameter>start</parameter>, будет возвращена пустая строка.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encoding</parameter></term>
     <listitem>
      &mbstring.encoding.parameter;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает часть строки
   <parameter>string</parameter>, которую задали аргументами
   <parameter>start</parameter> и <parameter>length</parameter>.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &mbstring.changelog.encoding-nullable;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mb_substr</function></member>
    <member><function>mb_internal_encoding</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
-->