mirror of
https://github.com/php/doc-ru.git
synced 2026-03-24 15:52:13 +01:00
146 lines
4.6 KiB
XML
146 lines
4.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<!-- EN-Revision: 906db3b3f78cfa98a7453e3910bcba95bc66d1ee Maintainer: tmn Status: ready -->
|
||
<!-- Reviewed: no -->
|
||
<refentry xml:id="streamwrapper.stream-read" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||
<refnamediv>
|
||
<refname>streamWrapper::stream_read</refname>
|
||
<refpurpose>Читает из потока</refpurpose>
|
||
</refnamediv>
|
||
|
||
<refsect1 role="description">
|
||
&reftitle.description;
|
||
<methodsynopsis>
|
||
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>streamWrapper::stream_read</methodname>
|
||
<methodparam><type>int</type><parameter>count</parameter></methodparam>
|
||
</methodsynopsis>
|
||
<para>
|
||
Этот метод вызывается в процессе выполнения функций
|
||
<function>fread</function> и <function>fgets</function>.
|
||
</para>
|
||
<note>
|
||
<para>
|
||
Не забывайте обновлять позицию чтения/записи в потоке (на количество успешно
|
||
прочитанных байт).
|
||
</para>
|
||
</note>
|
||
|
||
</refsect1>
|
||
|
||
<refsect1 role="parameters">
|
||
&reftitle.parameters;
|
||
<para>
|
||
<variablelist>
|
||
<varlistentry>
|
||
<term><parameter>count</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
Сколько байт данных от текущей позиции должно быть возвращено.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
</variablelist>
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="returnvalues">
|
||
&reftitle.returnvalues;
|
||
<para>
|
||
Если в потоке количество доступных байт меньше, чем <parameter>count</parameter>,
|
||
должно быть возвращено столько данных, сколько доступно.
|
||
Если доступных данных больше нет, функция возвращает &false;.
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="errors"><!-- {{{ -->
|
||
&reftitle.errors;
|
||
&userstream.not.implemented.warning;
|
||
<note>
|
||
<para>
|
||
Если возвращаемое значение будет больше, чем <parameter>count</parameter>,
|
||
то будет вызвана ошибка <constant>E_WARNING</constant>, и данные более
|
||
указанного количества будут потеряны.
|
||
</para>
|
||
</note>
|
||
</refsect1><!-- }}} -->
|
||
|
||
|
||
<!--
|
||
<refsect1 role="examples">
|
||
&reftitle.examples;
|
||
<para>
|
||
<example>
|
||
<title><function>streamWrapper::stream_read</function> example</title>
|
||
<programlisting role="php">
|
||
<![CDATA[
|
||
<?php
|
||
/* ... */
|
||
?>
|
||
]]>
|
||
</programlisting>
|
||
&example.outputs.similar;
|
||
<screen>
|
||
<![CDATA[
|
||
...
|
||
]]>
|
||
</screen>
|
||
</example>
|
||
</para>
|
||
</refsect1>
|
||
-->
|
||
|
||
<refsect1 role="notes"><!-- {{{ -->
|
||
&reftitle.notes;
|
||
<note>
|
||
<para>
|
||
<methodname>streamWrapper::stream_eof</methodname> вызывается сразу после вызова
|
||
<methodname>streamWrapper::stream_read</methodname>, чтобы проверить,
|
||
достигнут ли конец файла <acronym>EOF</acronym>. Если метод не реализован, то
|
||
полагается, что конец файла <acronym>EOF</acronym> достигнут.
|
||
</para>
|
||
</note>
|
||
<warning>
|
||
<para>
|
||
При чтении файла целиком (например, функцией
|
||
<function>file_get_contents</function>), PHP будет вызывать
|
||
<methodname>streamWrapper::stream_read</methodname> и вместе с ним
|
||
<methodname>streamWrapper::stream_eof</methodname> в цикле, пока
|
||
<methodname>streamWrapper::stream_read</methodname> возвращает
|
||
непустую строку. Возвращаемое из
|
||
<methodname>streamWrapper::stream_eof</methodname> значение при этом
|
||
игнорируется.
|
||
</para>
|
||
</warning>
|
||
</refsect1><!-- }}} -->
|
||
|
||
<refsect1 role="seealso">
|
||
&reftitle.seealso;
|
||
<para>
|
||
<simplelist>
|
||
<member><function>fread</function></member>
|
||
<member><function>fgets</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
|
||
-->
|