Skip to content

Commit

Permalink
Update shmop-read.xml to En + infostyle
Browse files Browse the repository at this point in the history
  • Loading branch information
mmalferov authored Feb 6, 2025
1 parent 291f0c6 commit 4470c52
Showing 1 changed file with 18 additions and 15 deletions.
33 changes: 18 additions & 15 deletions reference/shmop/functions/shmop-read.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<refentry xml:id="function.shmop-read" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>shmop_read</refname>
<refpurpose>Чтение данных из участка разделяемой памяти</refpurpose>
<refpurpose>Считывает данные из блока разделяемой памяти</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
Expand All @@ -15,7 +15,7 @@
<methodparam><type>int</type><parameter>size</parameter></methodparam>
</methodsynopsis>
<para>
<function>shmop_read</function> возвращает строковые данные, хранимые
Функция <function>shmop_read</function> возвращает строковые данные, которые хранятся
в участке разделяемой памяти.
</para>
</refsect1>
Expand All @@ -27,15 +27,15 @@
<term><parameter>shmop</parameter></term>
<listitem>
<para>
Ресурс блока памяти, возвращаемый функцией <function>shmop_open</function>
Ресурс блока памяти, который возвращает функция <function>shmop_open</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
Смещение, с которого начинается чтение; должно быть больше или равно нулю
Смещение, с которого начинается чтение; параметр принимает значение, которое больше или равно нулю
и меньше или равно фактическому размеру сегмента разделяемой памяти.
</para>
</listitem>
Expand All @@ -58,15 +58,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает строковые данные&return.falseforfailure;.
Функция возвращает данные, которые считала.
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<para>
Если параметр <parameter>offset</parameter> или <parameter>size</parameter>
находятся вне допустимого диапазона, выбрасывается исключение <classname>ValueError</classname>.
Функция выбрасывает ошибку <classname>ValueError</classname>,
если в аргументе <parameter>offset</parameter> или <parameter>size</parameter>
передали значение вне допустимого диапазона.
</para>
</refsect1>

Expand All @@ -84,15 +85,16 @@
<row>
<entry>8.0.0</entry>
<entry>
Параметр <parameter>shmop</parameter> ожидает экземпляр <classname>Shmop</classname>; ранее ожидался ресурс (<type>resource</type>).
Параметр <parameter>shmop</parameter> теперь ожидает экземпляр класса <classname>Shmop</classname>; раньше ожидался ресурс (<type>resource</type>).
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
Если параметр <parameter>offset</parameter> или <parameter>size</parameter>
находятся вне допустимого диапазона, выбрасывается исключение <classname>ValueError</classname>;
ранее выдавалась ошибка уровня <constant>E_WARNING</constant> и функция возвращала значение &false;.
Функция выбрасывает ошибку <classname>ValueError</classname>,
если в аргументе <parameter>offset</parameter> или <parameter>size</parameter>
передали значение вне допустимого диапазона;
раньше выдавалась ошибка уровня <constant>E_WARNING</constant> и функция возвращала значение &false;.
</entry>
</row>
</tbody>
Expand All @@ -104,20 +106,21 @@
&reftitle.examples;
<para>
<example>
<title>Чтение данных из участка разделяемой памяти</title>
<title>Пример считывания данных из участка разделяемой памяти</title>
<programlisting role="php">
<![CDATA[
<?php
$shm_data = shmop_read($shm_id, 0, 50);
?>
]]>
</programlisting>
</example>
</para>
<para>
В приведённом примере выполняется чтение 50 байт из участка разделяемой
памяти (идентифицируемого по <literal>$shm_id</literal>) и размещение в
<literal>$shm_data</literal>.
В приведённом примере функция считает из блока разделяемой памяти 50 байтов
и запишет данные в переменную <literal>$shm_data</literal>.
</para>
</refsect1>
<refsect1 role="seealso">
Expand Down

0 comments on commit 4470c52

Please sign in to comment.