[DOC-CVS] [doc-en] master: call.xml Add missing parameters, CS (#5492)
[email protected] (Mikhail Alferov via GitHub) Tue, 5 May 2026 20:16:06 +0000
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Mikhail Alferov (mmalferov)
Committer: GitHub (web-flow)
Pusher: kamil-tekiela
Date: 2026-05-05T21:16:04+01:00
Commit: https://github.com/php/doc-en/commit/c50df321d2cccb1044219a98d4c5c7677d4b29cf
Raw diff: https://github.com/php/doc-en/commit/c50df321d2cccb1044219a98d4c5c7677d4b29cf.diff
call.xml Add missing parameters, CS (#5492)
Changed paths:
M reference/yar/yar_concurrent_client/call.xml
Diff:
diff --git a/reference/yar/yar_concurrent_client/call.xml b/reference/yar/yar_concurrent_client/call.xml
index 2ffccdd829b2..ef2e48603b8c 100644
--- a/reference/yar/yar_concurrent_client/call.xml
+++ b/reference/yar/yar_concurrent_client/call.xml
@@ -20,7 +20,7 @@
</methodsynopsis>
<para>
Register a RPC call, but won't sent it immediately, it will be send while
- further call to <methodname>Yar_Concurrent_Client::loop</methodname>
+ further call to <methodname>Yar_Concurrent_Client::loop</methodname>.
</para>
</refsect1>
@@ -31,7 +31,7 @@
<term><parameter>uri</parameter></term>
<listitem>
<para>
- The RPC server URI(http, tcp)
+ The RPC server URI (HTTP, TCP).
</para>
</listitem>
</varlistentry>
@@ -39,7 +39,7 @@
<term><parameter>method</parameter></term>
<listitem>
<para>
- Service name(aka the method name)
+ Service name (aka the method name).
</para>
</listitem>
</varlistentry>
@@ -47,7 +47,7 @@
<term><parameter>parameters</parameter></term>
<listitem>
<para>
- Parameters
+ Parameters.
</para>
</listitem>
</varlistentry>
@@ -59,41 +59,62 @@
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><parameter>error_callback</parameter></term>
+ <listitem>
+ <simpara>
+ If this callback is set, then Yar will call this callback while error occurred.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>options</parameter></term>
+ <listitem>
+ <simpara>
+ An &array; of options.
+ See the <link linkend="yar.constants">constants</link> list.
+ </simpara>
+ </listitem>
+ </varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
- A unique id, can be used to identified which call it is.
- </para>
+ <simpara>
+ A unique ID, can be used to identified which call it is.
+ </simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <example>
- <title><function>Yar_Concurrent_Client::call</function> example</title>
+ <informalexample>
<programlisting role="php">
<![CDATA[
<?php
-function callback($retval, $callinfo) {
- var_dump($retval);
+
+function callback($retval, $callinfo)
+{
+ var_dump($retval);
}
-function error_callback($type, $error, $callinfo) {
+function error_callback($type, $error, $callinfo)
+{
error_log($error);
}
Yar_Concurrent_Client::call("http://host/api/", "some_method", array("parameters"), "callback");
-Yar_Concurrent_Client::call("http://host/api/", "some_method", array("parameters")); // if the callback is not specificed,
- // callback in loop will be used
+
+// If the callback is not specified callback in loop will be used
+Yar_Concurrent_Client::call("http://host/api/", "some_method", array("parameters"));
+
+// This server accept JSON packager
Yar_Concurrent_Client::call("http://host/api/", "some_method", array("parameters"), "callback", NULL, array(YAR_OPT_PACKAGER => "json"));
- //this server accept json packager
-Yar_Concurrent_Client::call("http://host/api/", "some_method", array("parameters"), "callback", NULL, array(YAR_OPT_TIMEOUT=>1));
- //custom timeout
-//The requests are not sent yet
-?>
+// Custom timeout
+Yar_Concurrent_Client::call("http://host/api/", "some_method", array("parameters"), "callback", NULL, array(YAR_OPT_TIMEOUT => 1));
+
+// The requests are not sent yet
]]>
</programlisting>
&example.outputs.similar;
@@ -101,10 +122,9 @@ Yar_Concurrent_Client::call("http://host/api/", "some_method", array("parameters
<![CDATA[
]]>
</screen>
- </example>
+ </informalexample>
</refsect1>
-
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>