mirror of
https://github.com/php/doc-ru.git
synced 2026-03-26 00:32:15 +01:00
312 lines
11 KiB
XML
312 lines
11 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<!-- EN-Revision: aca589264ab655bb1505d01e1a6d34cda6ba3d53 Maintainer: mch Status: ready -->
|
||
<!-- Reviewed: no -->
|
||
<refentry xml:id="function.stream-notification-callback" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||
<refnamediv>
|
||
<refname>stream_notification_callback</refname>
|
||
<refpurpose>Играет роль callback-функции для параметра контекста <literal>notification</literal></refpurpose>
|
||
</refnamediv>
|
||
|
||
<refsect1 role="description"><!-- {{{ -->
|
||
&reftitle.description;
|
||
<methodsynopsis>
|
||
<type>void</type><methodname><replaceable>stream_notification_callback</replaceable></methodname>
|
||
<methodparam><type>int</type><parameter>notification_code</parameter></methodparam>
|
||
<methodparam><type>int</type><parameter>severity</parameter></methodparam>
|
||
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>message</parameter></methodparam>
|
||
<methodparam><type>int</type><parameter>message_code</parameter></methodparam>
|
||
<methodparam><type>int</type><parameter>bytes_transferred</parameter></methodparam>
|
||
<methodparam><type>int</type><parameter>bytes_max</parameter></methodparam>
|
||
</methodsynopsis>
|
||
<para>
|
||
Функция с типом <type>callable</type>, которую передают как аргумент
|
||
для <link linkend="context.params.notification">контекстного параметра notification</link>,
|
||
которая вызывается при наступлении события.
|
||
</para>
|
||
<note>
|
||
<para>
|
||
Это <emphasis>не</emphasis> настоящая функция, а только прототип того, как нужно
|
||
реализовывать функцию.
|
||
</para>
|
||
</note>
|
||
</refsect1><!-- }}} -->
|
||
|
||
<refsect1 role="parameters"><!-- {{{ -->
|
||
&reftitle.parameters;
|
||
<para>
|
||
<variablelist>
|
||
<varlistentry>
|
||
<term><parameter>notification_code</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
Константа оповещения из семейства <constant>STREAM_NOTIFY_*</constant>.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>severity</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
Константа оповещения из семейства <constant>STREAM_NOTIFY_SEVERITY_*</constant>.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>message</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
Параметр передаётся, если у события есть доступ к описательному сообщению.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>message_code</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
Параметр передаётся, если у события есть доступ к описательному коду сообщения.
|
||
</para>
|
||
<para>
|
||
Смысл этого значения зависит от обёртки.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>bytes_transferred</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
Если применимо, то функция заполнит параметр <parameter>bytes_transferred</parameter>.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>bytes_max</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
Если применимо, то функция заполнит параметр <parameter>bytes_max</parameter>.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
|
||
</variablelist>
|
||
</para>
|
||
</refsect1><!-- }}} -->
|
||
|
||
<refsect1 role="returnvalues"><!-- {{{ -->
|
||
&reftitle.returnvalues;
|
||
<para>
|
||
&return.void;
|
||
</para>
|
||
</refsect1><!-- }}} -->
|
||
|
||
<refsect1 role="examples"><!-- {{{ -->
|
||
&reftitle.examples;
|
||
<para>
|
||
<example xml:id="stream-notification-callback.example.basic"><!-- {{{ -->
|
||
<title>Пример использования функции <function>stream_notification_callback</function></title>
|
||
<programlisting role="php">
|
||
<![CDATA[
|
||
<?php
|
||
|
||
function stream_notification_callback($notification_code, $severity, $message, $message_code, $bytes_transferred, $bytes_max)
|
||
{
|
||
switch ($notification_code) {
|
||
case STREAM_NOTIFY_RESOLVE:
|
||
case STREAM_NOTIFY_AUTH_REQUIRED:
|
||
case STREAM_NOTIFY_COMPLETED:
|
||
case STREAM_NOTIFY_FAILURE:
|
||
case STREAM_NOTIFY_AUTH_RESULT:
|
||
var_dump($notification_code, $severity, $message, $message_code, $bytes_transferred, $bytes_max);
|
||
/* Игнорируем */
|
||
break;
|
||
|
||
case STREAM_NOTIFY_REDIRECTED:
|
||
echo "Перенаправлены на: ", $message;
|
||
break;
|
||
|
||
case STREAM_NOTIFY_CONNECT:
|
||
echo "Подсоединились...";
|
||
break;
|
||
|
||
case STREAM_NOTIFY_FILE_SIZE_IS:
|
||
echo "Получили размер файла: ", $bytes_max;
|
||
break;
|
||
|
||
case STREAM_NOTIFY_MIME_TYPE_IS:
|
||
echo "Получили mime-тип файла: ", $message;
|
||
break;
|
||
|
||
case STREAM_NOTIFY_PROGRESS:
|
||
echo "Есть прогресс, функция скачала ", $bytes_transferred, " байтов";
|
||
break;
|
||
}
|
||
echo "\n";
|
||
}
|
||
|
||
$ctx = stream_context_create();
|
||
stream_context_set_params($ctx, array("notification" => "stream_notification_callback"));
|
||
|
||
file_get_contents("http://php.net/contact", false, $ctx);
|
||
|
||
|
||
?>
|
||
]]>
|
||
</programlisting>
|
||
&example.outputs.similar;
|
||
<screen>
|
||
<![CDATA[
|
||
Подсоединились...
|
||
Получили mime-тип файла: text/html; charset=utf-8
|
||
Перенаправлены на: http://no.php.net/contact
|
||
Подсоединились...
|
||
Получили размер файла: 0
|
||
Получили mime-тип файла: text/html; charset=utf-8
|
||
Перенаправлены на: http://no.php.net/contact.php
|
||
Подсоединились...
|
||
Получили размер файла: 4589
|
||
Получили mime-тип файла: text/html;charset=utf-8
|
||
Есть прогресс, функция скачала 0 байтов
|
||
Есть прогресс, функция скачала 0 байтов
|
||
Есть прогресс, функция скачала 0 байтов
|
||
Есть прогресс, функция скачала 1440 байтов
|
||
Есть прогресс, функция скачала 2880 байтов
|
||
Есть прогресс, функция скачала 4320 байтов
|
||
Есть прогресс, функция скачала 5760 байтов
|
||
Есть прогресс, функция скачала 6381 байтов
|
||
Есть прогресс, функция скачала 7002 байтов
|
||
]]>
|
||
</screen>
|
||
</example><!-- }}} -->
|
||
</para>
|
||
<para>
|
||
<example xml:id="stream-notification-callback.example.download"><!-- {{{ -->
|
||
<title>Пример простого индикатора для загрузчика файлов из командной строки</title>
|
||
<programlisting role="php">
|
||
<![CDATA[
|
||
<?php
|
||
|
||
function usage($argv)
|
||
{
|
||
echo "Использование:\n";
|
||
printf("\tphp %s <http://example.com/file> <localfile>\n", $argv[0]);
|
||
exit(1);
|
||
}
|
||
|
||
function stream_notification_callback(
|
||
$notification_code,
|
||
$severity,
|
||
$message,
|
||
$message_code,
|
||
$bytes_transferred,
|
||
$bytes_max,
|
||
) {
|
||
static $filesize = null;
|
||
|
||
switch ($notification_code) {
|
||
case STREAM_NOTIFY_RESOLVE:
|
||
case STREAM_NOTIFY_AUTH_REQUIRED:
|
||
case STREAM_NOTIFY_COMPLETED:
|
||
case STREAM_NOTIFY_FAILURE:
|
||
case STREAM_NOTIFY_AUTH_RESULT:
|
||
/* Игнорируем */
|
||
break;
|
||
|
||
case STREAM_NOTIFY_REDIRECTED:
|
||
echo "Перенаправлены на: ", $message, "\n";
|
||
break;
|
||
|
||
case STREAM_NOTIFY_CONNECT:
|
||
echo "Подсоединились...\n";
|
||
break;
|
||
|
||
case STREAM_NOTIFY_FILE_SIZE_IS:
|
||
$filesize = $bytes_max;
|
||
echo "Размер файла: ", $filesize, "\n";
|
||
break;
|
||
|
||
case STREAM_NOTIFY_MIME_TYPE_IS:
|
||
echo "Mime-тип файла: ", $message, "\n";
|
||
break;
|
||
|
||
case STREAM_NOTIFY_PROGRESS:
|
||
if ($bytes_transferred > 0) {
|
||
if (!isset($filesize)) {
|
||
printf("\rНеизвестный размер файла.. Закачано %2d Кб..", $bytes_transferred / 1024);
|
||
} else {
|
||
$length = (int)(($bytes_transferred / $filesize) * 100);
|
||
printf("\r[%-100s] %d%% (%2d/%2d kb)", str_repeat("=", $length) . ">", $length, ($bytes_transferred / 1024), $filesize / 1024);
|
||
}
|
||
}
|
||
break;
|
||
}
|
||
}
|
||
|
||
isset($argv[1], $argv[2]) or usage($argv);
|
||
|
||
$ctx = stream_context_create();
|
||
stream_context_set_params($ctx, array("notification" => "stream_notification_callback"));
|
||
|
||
$fp = fopen($argv[1], "r", false, $ctx);
|
||
if (is_resource($fp) && file_put_contents($argv[2], $fp)) {
|
||
echo "\nГотово!\n";
|
||
exit(0);
|
||
}
|
||
|
||
$err = error_get_last();
|
||
echo "\nОш-ш-ш-ш-шиб-бка..\n", $err["message"], "\n";
|
||
exit(1);
|
||
|
||
?>
|
||
]]>
|
||
</programlisting>
|
||
<para>
|
||
Выполнение приведённого примера со следующими опциями:
|
||
<literal>php -n fetch.php
|
||
http://no2.php.net/get/php-5-LATEST.tar.bz2/from/this/mirror
|
||
php-latest.tar.bz2</literal> выведет что-то похожее на это:
|
||
</para>
|
||
<screen>
|
||
<![CDATA[
|
||
Подсоединились...
|
||
Mime-тип файла: text/html; charset=utf-8
|
||
Перенаправлены на: http://no2.php.net/distributions/php-5.2.5.tar.bz2
|
||
Подсоединились...
|
||
Размер файла: 7773024
|
||
Mime-тип файла: application/octet-stream
|
||
[========================================> ] 40% (3076/7590 kb)
|
||
]]>
|
||
</screen>
|
||
</example>
|
||
</para>
|
||
</refsect1><!-- }}} -->
|
||
|
||
<refsect1 role="seealso"><!-- {{{ -->
|
||
&reftitle.seealso;
|
||
<para>
|
||
<simplelist>
|
||
<member><xref linkend="context.params" /></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
|
||
-->
|