php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

stomp: fix XML to remove useless wrapping para tags via script

Browse Source
This commit is contained in:
Gina Peter Banyard
2026-01-25 16:06:13 +00:00
parent 2885123b1a
commit d0ec3a70d1
20 changed files with 508 additions and 632 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
reference/stomp/examples.xml
View File

@@ -1,13 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<chapter xml:id="stomp.examples" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="stomp.examples">
&reftitle.examples;
<!-- section xml:id="stomp.examples-overview" -->
<para>
<example>
<title>&style.oop;</title>
<programlisting role="php">
<example>
<title>&style.oop;</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -42,9 +40,9 @@ unset($stomp);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
object(StompFrame)#2 (3) {
["command"]=>
@@ -66,13 +64,11 @@ object(StompFrame)#2 (3) {
string(3) "bar"
}
]]>
</screen>
</example>
</para>
<para>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
</screen>
</example>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -114,9 +110,9 @@ stomp_close($link);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
array(3) {
["command"]=>
@@ -140,12 +136,10 @@ array(3) {
}
}
]]>
</screen>
</example>
</para>
</screen>
</example>
<!-- /section -->
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -166,4 +160,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

26
reference/stomp/functions/stomp-connect-error.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.stomp-connect-error" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.stomp-connect-error">
<refnamediv>
<refname>stomp_connect_error</refname>
<refpurpose>Returns a string description of the last connect error</refpurpose>
@@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>stomp_connect_error</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Returns a string description of the last connect error.
@@ -26,16 +25,15 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A string that describes the error, or &null; if no error occurred.
A string that describes the error, or &null; if no error occurred.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>stomp_connect_error</function> example</title>
<programlisting role="php">
<example>
<title><function>stomp_connect_error</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$link = stomp_connect('http://localhost:61613');
@@ -45,20 +43,18 @@ if(!$link) {
}
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Connection failed: Invalid Broker URI scheme
]]>
</screen>
</example>
</para>
</screen>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

24
reference/stomp/functions/stomp-version.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.stomp-version" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.stomp-version">
<refnamediv>
<refname>stomp_version</refname>
<refpurpose>Gets the current stomp extension version</refpurpose>
@@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>stomp_version</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Returns a string containing the version of the current stomp extension.
@@ -32,10 +31,9 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>stomp_version</function> example</title>
<programlisting role="php">
<example>
<title><function>stomp_version</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -43,20 +41,18 @@ var_dump(stomp_version());
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
string(5) "0.2.0"
]]>
</screen>
</example>
</para>
</screen>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

209
reference/stomp/ini.xml
View File

@@ -1,119 +1,114 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="stomp.configuration" xmlns="http://docbook.org/ns/docbook">
<section xmlns="http://docbook.org/ns/docbook" xml:id="stomp.configuration">
&reftitle.runtime;
&extension.runtime;
<para>
<table>
<title>Stomp &ConfigureOptions;</title>
<tgroup cols="4">
<thead>
<row>
<entry>&Name;</entry>
<entry>&Default;</entry>
<entry>&Changeable;</entry>
<entry>&Changelog;</entry>
</row>
</thead>
<tbody>
<row>
<entry><link linkend="ini.stomp.default-broker">stomp.default_broker</link></entry>
<entry>tcp://localhost:61613</entry>
<entry><constant>INI_ALL</constant></entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry><link linkend="ini.stomp.default-connection-timeout-sec">stomp.default_connection_timeout_sec</link></entry>
<entry>2</entry>
<entry><constant>INI_ALL</constant></entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry><link linkend="ini.stomp.default-connection-timeout-usec">stomp.default_connection_timeout_usec</link></entry>
<entry>0</entry>
<entry><constant>INI_ALL</constant></entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<table>
<title>Stomp &ConfigureOptions;</title>
<tgroup cols="4">
<thead>
<row>
<entry>&Name;</entry>
<entry>&Default;</entry>
<entry>&Changeable;</entry>
<entry>&Changelog;</entry>
</row>
</thead>
<tbody>
<row>
<entry><link linkend="ini.stomp.default-broker">stomp.default_broker</link></entry>
<entry>tcp://localhost:61613</entry>
<entry><constant>INI_ALL</constant></entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry><link linkend="ini.stomp.default-connection-timeout-sec">stomp.default_connection_timeout_sec</link></entry>
<entry>2</entry>
<entry><constant>INI_ALL</constant></entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry><link linkend="ini.stomp.default-connection-timeout-usec">stomp.default_connection_timeout_usec</link></entry>
<entry>0</entry>
<entry><constant>INI_ALL</constant></entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry><link linkend="ini.stomp.default-read-timeout-sec">stomp.default_read_timeout_sec</link></entry>
<entry>2</entry>
<entry><constant>INI_ALL</constant></entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry><link linkend="ini.stomp.default-read-timeout-usec">stomp.default_read_timeout_usec</link></entry>
<entry>0</entry>
<entry><constant>INI_ALL</constant></entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry><link linkend="ini.stomp.default-read-timeout-sec">stomp.default_read_timeout_sec</link></entry>
<entry>2</entry>
<entry><constant>INI_ALL</constant></entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry><link linkend="ini.stomp.default-read-timeout-usec">stomp.default_read_timeout_usec</link></entry>
<entry>0</entry>
<entry><constant>INI_ALL</constant></entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</tgroup>
</table>
&ini.descriptions.title;
<para>
<variablelist>
<varlistentry xml:id="ini.stomp.default-broker">
<term>
<parameter>stomp.default_broker</parameter>
<type>string</type>
</term>
<listitem>
<para>
The default broker URI to use when connecting to the message broker if no other URI is specified.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.stomp.default-connection-timeout-sec">
<term>
<parameter>stomp.default_connection_timeout_sec</parameter>
<type>int</type>
</term>
<listitem>
<para>
The seconds part of the default connection timeout.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.stomp.default-connection-timeout-usec">
<term>
<parameter>stomp.default_connection_timeout_usec</parameter>
<type>int</type>
</term>
<listitem>
<para>
The microseconds part of the default connection timeout.
</para>
</listitem>
</varlistentry>
<variablelist>
<varlistentry xml:id="ini.stomp.default-broker">
<term>
<parameter>stomp.default_broker</parameter>
<type>string</type>
</term>
<listitem>
<para>
The default broker URI to use when connecting to the message broker if no other URI is specified.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.stomp.default-connection-timeout-sec">
<term>
<parameter>stomp.default_connection_timeout_sec</parameter>
<type>int</type>
</term>
<listitem>
<para>
The seconds part of the default connection timeout.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.stomp.default-connection-timeout-usec">
<term>
<parameter>stomp.default_connection_timeout_usec</parameter>
<type>int</type>
</term>
<listitem>
<para>
The microseconds part of the default connection timeout.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.stomp.default-read-timeout-sec">
<term>
<parameter>stomp.default_read_timeout_sec</parameter>
<type>int</type>
</term>
<listitem>
<para>
The seconds part of the default reading timeout.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.stomp.default-read-timeout-usec">
<term>
<parameter>stomp.default_read_timeout_usec</parameter>
<type>int</type>
</term>
<listitem>
<para>
The microseconds part of the default reading timeout.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.stomp.default-read-timeout-sec">
<term>
<parameter>stomp.default_read_timeout_sec</parameter>
<type>int</type>
</term>
<listitem>
<para>
The seconds part of the default reading timeout.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.stomp.default-read-timeout-usec">
<term>
<parameter>stomp.default_read_timeout_usec</parameter>
<type>int</type>
</term>
<listitem>
<para>
The microseconds part of the default reading timeout.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</variablelist>
</section>

54
reference/stomp/stomp/abort.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="stomp.abort" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="stomp.abort">
<refnamediv>
<refname>Stomp::abort</refname>
<refname>stomp_abort</refname>
@@ -30,20 +29,18 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&stomp.param.link;
<varlistentry>
<term><parameter>transaction_id</parameter></term>
<listitem>
<para>
The transaction to abort.
</para>
</listitem>
</varlistentry>
&stomp.param.headers;
</variablelist>
</para>
<variablelist>
&stomp.param.link;
<varlistentry>
<term><parameter>transaction_id</parameter></term>
<listitem>
<para>
The transaction to abort.
</para>
</listitem>
</varlistentry>
&stomp.param.headers;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -55,10 +52,9 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>&style.oop;</title>
<programlisting role="php">
<example>
<title>&style.oop;</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -82,13 +78,11 @@ $stomp->abort('t1');
unset($stomp);
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
</programlisting>
</example>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -114,9 +108,8 @@ stomp_close($link);
?>
]]>
</programlisting>
</example>
</para>
</programlisting>
</example>
</refsect1>
<refsect1 role="notes">
@@ -125,7 +118,6 @@ stomp_close($link);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

54
reference/stomp/stomp/ack.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="stomp.ack" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="stomp.ack">
<refnamediv>
<refname>Stomp::ack</refname>
<refname>stomp_ack</refname>
@@ -30,20 +29,18 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&stomp.param.link;
<varlistentry>
<term><parameter>msg</parameter></term>
<listitem>
<para>
The message/messageId to be acknowledged.
</para>
</listitem>
</varlistentry>
&stomp.param.headers;
</variablelist>
</para>
<variablelist>
&stomp.param.link;
<varlistentry>
<term><parameter>msg</parameter></term>
<listitem>
<para>
The message/messageId to be acknowledged.
</para>
</listitem>
</varlistentry>
&stomp.param.headers;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -55,10 +52,9 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>&style.oop;</title>
<programlisting role="php">
<example>
<title>&style.oop;</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -94,13 +90,11 @@ unset($stomp);
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
</programlisting>
</example>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -143,9 +137,8 @@ stomp_close($link);
?>
]]>
</programlisting>
</example>
</para>
</programlisting>
</example>
</refsect1>
<refsect1 role="notes">
@@ -155,7 +148,6 @@ stomp_close($link);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/stomp/stomp/begin.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="stomp.begin" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="stomp.begin">
<refnamediv>
<refname>Stomp::begin</refname>
<refname>stomp_begin</refname>
@@ -30,20 +29,18 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&stomp.param.link;
<varlistentry>
<term><parameter>transaction_id</parameter></term>
<listitem>
<para>
The transaction id.
</para>
</listitem>
</varlistentry>
&stomp.param.headers;
</variablelist>
</para>
<variablelist>
&stomp.param.link;
<varlistentry>
<term><parameter>transaction_id</parameter></term>
<listitem>
<para>
The transaction id.
</para>
</listitem>
</varlistentry>
&stomp.param.headers;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -66,7 +63,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

54
reference/stomp/stomp/commit.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="stomp.commit" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="stomp.commit">
<refnamediv>
<refname>Stomp::commit</refname>
<refname>stomp_commit</refname>
@@ -30,20 +29,18 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&stomp.param.link;
<varlistentry>
<term><parameter>transaction_id</parameter></term>
<listitem>
<para>
The transaction id.
</para>
</listitem>
</varlistentry>
&stomp.param.headers;
</variablelist>
</para>
<variablelist>
&stomp.param.link;
<varlistentry>
<term><parameter>transaction_id</parameter></term>
<listitem>
<para>
The transaction id.
</para>
</listitem>
</varlistentry>
&stomp.param.headers;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -55,10 +52,9 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>&style.oop;</title>
<programlisting role="php">
<example>
<title>&style.oop;</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -83,13 +79,11 @@ unset($stomp);
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
</programlisting>
</example>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -115,9 +109,8 @@ stomp_close($link);
?>
]]>
</programlisting>
</example>
</para>
</programlisting>
</example>
</refsect1>
<refsect1 role="notes">
@@ -126,7 +119,6 @@ stomp_close($link);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

122
reference/stomp/stomp/construct.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="stomp.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="stomp.construct">
<refnamediv>
<refname>Stomp::__construct</refname>
<refname>stomp_connect</refname>
@@ -33,35 +32,33 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>broker</parameter></term>
<listitem>
<para>
The broker URI
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<para>
The username.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The password.
</para>
</listitem>
</varlistentry>
&stomp.param.headers;
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>broker</parameter></term>
<listitem>
<para>
The broker URI
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<para>
The username.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The password.
</para>
</listitem>
</varlistentry>
&stomp.param.headers;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -71,34 +68,31 @@
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PECL stomp 1.0.1</entry>
<entry>
The <parameter>headers</parameter> parameter was added
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PECL stomp 1.0.1</entry>
<entry>
The <parameter>headers</parameter> parameter was added
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>&style.oop;</title>
<programlisting role="php">
<example>
<title>&style.oop;</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -114,13 +108,11 @@ unset($stomp);
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
</programlisting>
</example>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -137,13 +129,11 @@ stomp_close($link);
?>
]]>
</programlisting>
</example>
</para>
</programlisting>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/stomp/stomp/destruct.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="stomp.destruct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="stomp.destruct">
<refnamediv>
<refname>Stomp::__destruct</refname>
<refname>stomp_close</refname>
@@ -13,7 +12,7 @@
<para>&style.oop; (destructor):</para>
<destructorsynopsis>
<modifier>public</modifier> <methodname>Stomp::__destruct</methodname>
<void />
<void/>
</destructorsynopsis>
<para>&style.procedural;:</para>
<methodsynopsis>
@@ -27,11 +26,9 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&stomp.param.link;
</variablelist>
</para>
<variablelist>
&stomp.param.link;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -48,7 +45,6 @@
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

52
reference/stomp/stomp/error.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="stomp.error" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="stomp.error">
<refnamediv>
<refname>Stomp::error</refname>
<refname>stomp_error</refname>
@@ -13,7 +12,7 @@
<para>&style.oop; (method):</para>
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>Stomp::error</methodname>
<void />
<void/>
</methodsynopsis>
<para>&style.procedural;:</para>
<methodsynopsis>
@@ -27,11 +26,9 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&stomp.param.link;
</variablelist>
</para>
<variablelist>
&stomp.param.link;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -43,10 +40,9 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>&style.oop;</title>
<programlisting role="php">
<example>
<title>&style.oop;</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -68,20 +64,18 @@ unset($stomp);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
bool(false)
string(43) "Invalid transaction id: unknown-transaction"
]]>
</screen>
</example>
</para>
<para>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
</screen>
</example>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -104,21 +98,19 @@ stomp_close($link);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
bool(false)
string(43) "Invalid transaction id: unknown-transaction"
]]>
</screen>
</example>
</para>
]]>
</screen>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

52
reference/stomp/stomp/getreadtimeout.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="stomp.getreadtimeout" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="stomp.getreadtimeout">
<refnamediv>
<refname>Stomp::getReadTimeout</refname>
<refname>stomp_get_read_timeout</refname>
@@ -13,7 +12,7 @@
<para>&style.oop; (method):</para>
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>Stomp::getReadTimeout</methodname>
<void />
<void/>
</methodsynopsis>
<para>&style.procedural;:</para>
<methodsynopsis>
@@ -27,26 +26,23 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&stomp.param.link;
</variablelist>
</para>
<variablelist>
&stomp.param.link;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array with 2 elements: sec and usec.
Returns an array with 2 elements: sec and usec.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>&style.oop;</title>
<programlisting role="php">
<example>
<title>&style.oop;</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -64,9 +60,9 @@ unset($stomp);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
array(2) {
["sec"]=>
@@ -75,13 +71,11 @@ array(2) {
int(0)
}
]]>
</screen>
</example>
</para>
<para>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
</screen>
</example>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -100,9 +94,9 @@ stomp_close($link);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
array(2) {
["sec"]=>
@@ -111,14 +105,12 @@ array(2) {
int(0)
}
]]>
</screen>
</example>
</para>
</screen>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

50
reference/stomp/stomp/getsessionid.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="stomp.getsessionid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="stomp.getsessionid">
<refnamediv>
<refname>Stomp::getSessionId</refname>
<refname>stomp_get_session_id</refname>
@@ -13,7 +12,7 @@
<para>&style.oop; (method):</para>
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>Stomp::getSessionId</methodname>
<void />
<void/>
</methodsynopsis>
<para>&style.procedural;:</para>
<methodsynopsis>
@@ -27,11 +26,9 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&stomp.param.link;
</variablelist>
</para>
<variablelist>
&stomp.param.link;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -43,10 +40,9 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>&style.oop;</title>
<programlisting role="php">
<example>
<title>&style.oop;</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -64,19 +60,17 @@ unset($stomp);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
string(35) "ID:php.net-52873-1257291895530-4:14"
]]>
</screen>
</example>
</para>
<para>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
</screen>
</example>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -95,20 +89,18 @@ stomp_close($link);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
string(35) "ID:php.net-52873-1257291895530-4:14"
]]>
</screen>
</example>
</para>
</screen>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/stomp/stomp/hasframe.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="stomp.hasframe" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="stomp.hasframe">
<refnamediv>
<refname>Stomp::hasFrame</refname>
<refname>stomp_has_frame</refname>
@@ -13,7 +12,7 @@
<para>&style.oop; (method):</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Stomp::hasFrame</methodname>
<void />
<void/>
</methodsynopsis>
<para>&style.procedural;:</para>
<methodsynopsis>
@@ -27,11 +26,9 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&stomp.param.link;
</variablelist>
</para>
<variablelist>
&stomp.param.link;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -42,7 +39,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

104
reference/stomp/stomp/readframe.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="stomp.readframe" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="stomp.readframe">
<refnamediv>
<refname>Stomp::readFrame</refname>
<refname>stomp_read_frame</refname>
@@ -21,25 +20,23 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
Reads the next frame. It is possible to instantiate an object of a specific class, and pass parameters to that class's constructor.
Reads the next frame. It is possible to instantiate an object of a specific class, and pass parameters to that class's constructor.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&stomp.param.link;
<varlistentry>
<term><parameter>class_name</parameter></term>
<listitem>
<para>
The name of the class to instantiate. If not specified, a stompFrame object is returned.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
&stomp.param.link;
<varlistentry>
<term><parameter>class_name</parameter></term>
<listitem>
<para>
The name of the class to instantiate. If not specified, a stompFrame object is returned.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -49,34 +46,31 @@
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PECL stomp 0.4.0</entry>
<entry>
<parameter>class_name</parameter> parameter was added.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PECL stomp 0.4.0</entry>
<entry>
<parameter>class_name</parameter> parameter was added.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>&style.oop;</title>
<programlisting role="php">
<example>
<title>&style.oop;</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -98,9 +92,9 @@ unset($stomp);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
object(StompFrame)#2 (3) {
["command"]=>
@@ -122,13 +116,11 @@ object(StompFrame)#2 (3) {
string(3) "bar"
}
]]>
</screen>
</example>
</para>
<para>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
</screen>
</example>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -151,9 +143,9 @@ stomp_close($link);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
array(3) {
["command"]=>
@@ -177,13 +169,11 @@ array(3) {
}
}
]]>
</screen>
</example>
</para>
</screen>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

48
reference/stomp/stomp/send.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="stomp.send" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="stomp.send">
<refnamediv>
<refname>Stomp::send</refname>
<refname>stomp_send</refname>
@@ -32,34 +31,32 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&stomp.param.link;
<varlistentry>
<term><parameter>destination</parameter></term>
<listitem>
<para>
Where to send the message
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>msg</parameter></term>
<listitem>
<para>
Message to send.
</para>
</listitem>
</varlistentry>
&stomp.param.headers;
</variablelist>
</para>
<variablelist>
&stomp.param.link;
<varlistentry>
<term><parameter>destination</parameter></term>
<listitem>
<para>
Where to send the message
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>msg</parameter></term>
<listitem>
<para>
Message to send.
</para>
</listitem>
</varlistentry>
&stomp.param.headers;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.success;
</para>
</refsect1>
@@ -77,7 +74,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

74
reference/stomp/stomp/setreadtimeout.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="stomp.setreadtimeout" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="stomp.setreadtimeout">
<refnamediv>
<refname>Stomp::setReadTimeout</refname>
<refname>stomp_set_read_timeout</refname>
@@ -30,27 +29,25 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&stomp.param.link;
<varlistentry>
<term><parameter>seconds</parameter></term>
<listitem>
<para>
The seconds part of the timeout to be set.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>microseconds</parameter></term>
<listitem>
<para>
The microseconds part of the timeout to be set.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
&stomp.param.link;
<varlistentry>
<term><parameter>seconds</parameter></term>
<listitem>
<para>
The seconds part of the timeout to be set.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>microseconds</parameter></term>
<listitem>
<para>
The microseconds part of the timeout to be set.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -59,13 +56,12 @@
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>&style.oop;</title>
<programlisting role="php">
<example>
<title>&style.oop;</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -77,19 +73,17 @@ try {
}
$stomp->setReadTimeout(10);
/* close connection */
unset($stomp);
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
</programlisting>
</example>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -102,19 +96,17 @@ if (!$link) {
}
stomp_set_read_timeout($link, 10);
/* close connection */
stomp_close($link);
?>
]]>
</programlisting>
</example>
</para>
</programlisting>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/stomp/stomp/subscribe.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="stomp.subscribe" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="stomp.subscribe">
<refnamediv>
<refname>Stomp::subscribe</refname>
<refname>stomp_subscribe</refname>
@@ -30,20 +29,18 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&stomp.param.link;
<varlistentry>
<term><parameter>destination</parameter></term>
<listitem>
<para>
Destination to subscribe to.
</para>
</listitem>
</varlistentry>
&stomp.param.headers;
</variablelist>
</para>
<variablelist>
&stomp.param.link;
<varlistentry>
<term><parameter>destination</parameter></term>
<listitem>
<para>
Destination to subscribe to.
</para>
</listitem>
</varlistentry>
&stomp.param.headers;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -66,7 +63,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/stomp/stomp/unsubscribe.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="stomp.unsubscribe" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="stomp.unsubscribe">
<refnamediv>
<refname>Stomp::unsubscribe</refname>
<refname>stomp_unsubscribe</refname>
@@ -30,20 +29,18 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&stomp.param.link;
<varlistentry>
<term><parameter>destination</parameter></term>
<listitem>
<para>
Subscription to remove.
</para>
</listitem>
</varlistentry>
&stomp.param.headers;
</variablelist>
</para>
<variablelist>
&stomp.param.link;
<varlistentry>
<term><parameter>destination</parameter></term>
<listitem>
<para>
Subscription to remove.
</para>
</listitem>
</varlistentry>
&stomp.param.headers;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -66,7 +63,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

58
reference/stomp/stompframe/construct.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="stompframe.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="stompframe.construct">
<refnamediv>
<refname>StompFrame::__construct</refname>
<refpurpose>Constructor</refpurpose>
@@ -22,37 +21,34 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>command</parameter></term>
<listitem>
<para>
Frame command
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>headers</parameter></term>
<listitem>
<para>
Frame headers (&array;).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>body</parameter></term>
<listitem>
<para>
Frame body.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>command</parameter></term>
<listitem>
<para>
Frame command
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>headers</parameter></term>
<listitem>
<para>
Frame headers (&array;).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>body</parameter></term>
<listitem>
<para>
Frame body.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml