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 by converting para to simpara tags via script

Browse Source
This commit is contained in:
Gina Peter Banyard
2026-01-25 16:06:13 +00:00
parent d0ec3a70d1
commit 9c7e8795cb
25 changed files with 187 additions and 201 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
reference/stomp/book.xml
View File

@@ -1,16 +1,15 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<book xml:id="book.stomp" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.stomp">
<?phpdoc extension-membership="pecl" ?>
<title>Stomp Client</title>
<titleabbrev>Stomp</titleabbrev>
<preface xml:id="intro.stomp">
&reftitle.intro;
<para>
<simpara>
This extension allows php applications to communicate with any Stomp compliant Message Brokers through easy object-oriented and procedural interfaces. <link xlink:href="&url.stomp;">Stomp official site</link>
</para>
</simpara>
</preface>
&reference.stomp.setup;
@@ -20,7 +19,6 @@ This extension allows php applications to communicate with any Stomp compliant M
&reference.stomp.stompframe;
&reference.stomp.stompexception;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -41,4 +39,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

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

@@ -12,9 +12,9 @@
<type>string</type><methodname>stomp_connect_error</methodname>
<void/>
</methodsynopsis>
<para>
<simpara>
Returns a string description of the last connect error.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
A string that describes the error, or &null; if no error occurred.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

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

@@ -12,9 +12,9 @@
<type>string</type><methodname>stomp_version</methodname>
<void/>
</methodsynopsis>
<para>
<simpara>
Returns a string containing the version of the current stomp extension.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
It returns the current stomp extension version
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

20
reference/stomp/ini.xml
View File

@@ -59,9 +59,9 @@
<type>string</type>
</term>
<listitem>
<para>
<simpara>
The default broker URI to use when connecting to the message broker if no other URI is specified.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.stomp.default-connection-timeout-sec">
@@ -70,9 +70,9 @@
<type>int</type>
</term>
<listitem>
<para>
<simpara>
The seconds part of the default connection timeout.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.stomp.default-connection-timeout-usec">
@@ -81,9 +81,9 @@
<type>int</type>
</term>
<listitem>
<para>
<simpara>
The microseconds part of the default connection timeout.
</para>
</simpara>
</listitem>
</varlistentry>
@@ -93,9 +93,9 @@
<type>int</type>
</term>
<listitem>
<para>
<simpara>
The seconds part of the default reading timeout.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.stomp.default-read-timeout-usec">
@@ -104,9 +104,9 @@
<type>int</type>
</term>
<listitem>
<para>
<simpara>
The microseconds part of the default reading timeout.
</para>
</simpara>
</listitem>
</varlistentry>

15
reference/stomp/setup.xml
View File

@@ -1,20 +1,19 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<chapter xml:id="stomp.setup" 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.setup">
&reftitle.setup;
<section xml:id="stomp.requirements">
&reftitle.required;
<para>The <link xlink:href="&url.openssl;">OpenSSL</link> package >= 0.9.6 and the <link linkend="book.openssl">openssl</link> extension may also be required to use stomp over SSL.</para>
<simpara>The <link xlink:href="&url.openssl;">OpenSSL</link> package &gt;= 0.9.6 and the <link linkend="book.openssl">openssl</link> extension may also be required to use stomp over SSL.</simpara>
</section>
<section xml:id="stomp.installation">
&reftitle.install;
<para>
<simpara>
&pecl.info;
<link xlink:href="&url.pecl.package;stomp">&url.pecl.package;stomp</link>
</para>
</simpara>
</section>
<!-- {{{ Configuration -->
@@ -24,15 +23,14 @@
<!-- {{{ Resources -->
<section xml:id="stomp.resources">
&reftitle.resources;
<para>
<simpara>
There is only one resource type used in the stomp extension - it's
the link identifier for a stomp connection.
</para>
</simpara>
</section>
<!-- }}} -->
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -53,4 +51,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

16
reference/stomp/stomp.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.stomp" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.stomp" role="class">
<title>The Stomp class</title>
<titleabbrev>Stomp</titleabbrev>
@@ -11,9 +10,9 @@
<!-- {{{ Stomp intro -->
<section xml:id="stomp.intro">
&reftitle.intro;
<para>
<simpara>
Represents a connection between PHP and a Stomp compliant Message Broker.
</para>
</simpara>
</section>
<!-- }}} -->
@@ -31,11 +30,11 @@ Represents a connection between PHP and a Stomp compliant Message Broker.
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.stomp')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.stomp')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.stomp')/db:refentry/db:refsect1[@role='description']/descendant::db:destructorsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.stomp')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.stomp')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.stomp')/db:refentry/db:refsect1[@role='description']/descendant::db:destructorsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -46,7 +45,6 @@ Represents a connection between PHP and a Stomp compliant Message Broker.
&reference.stomp.entities.stomp;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

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

@@ -9,22 +9,22 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (method):</para>
<simpara>&style.oop; (method):</simpara>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Stomp::abort</methodname>
<methodparam><type>string</type><parameter>transaction_id</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>headers</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;:</para>
<simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type>bool</type><methodname>stomp_abort</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
<methodparam><type>string</type><parameter>transaction_id</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>headers</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Rolls back a transaction in progress.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -34,9 +34,9 @@
<varlistentry>
<term><parameter>transaction_id</parameter></term>
<listitem>
<para>
<simpara>
The transaction to abort.
</para>
</simpara>
</listitem>
</varlistentry>
&stomp.param.headers;
@@ -45,9 +45,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

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

@@ -9,22 +9,22 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (method):</para>
<simpara>&style.oop; (method):</simpara>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Stomp::ack</methodname>
<methodparam><type>mixed</type><parameter>msg</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>headers</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;:</para>
<simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type>bool</type><methodname>stomp_ack</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
<methodparam><type>mixed</type><parameter>msg</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>headers</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Acknowledges consumption of a message from a subscription using client acknowledgment.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -34,9 +34,9 @@
<varlistentry>
<term><parameter>msg</parameter></term>
<listitem>
<para>
<simpara>
The message/messageId to be acknowledged.
</para>
</simpara>
</listitem>
</varlistentry>
&stomp.param.headers;
@@ -45,9 +45,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

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

@@ -9,22 +9,22 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (method):</para>
<simpara>&style.oop; (method):</simpara>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Stomp::begin</methodname>
<methodparam><type>string</type><parameter>transaction_id</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>headers</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;:</para>
<simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type>bool</type><methodname>stomp_begin</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
<methodparam><type>string</type><parameter>transaction_id</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>headers</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Starts a transaction.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -34,9 +34,9 @@
<varlistentry>
<term><parameter>transaction_id</parameter></term>
<listitem>
<para>
<simpara>
The transaction id.
</para>
</simpara>
</listitem>
</varlistentry>
&stomp.param.headers;
@@ -45,16 +45,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<simpara>
See <function>stomp_commit</function> or <function>stomp_abort</function>.
</para>
</simpara>
</refsect1>
<refsect1 role="notes">

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

@@ -9,22 +9,22 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (method):</para>
<simpara>&style.oop; (method):</simpara>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Stomp::commit</methodname>
<methodparam><type>string</type><parameter>transaction_id</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>headers</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;:</para>
<simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type>bool</type><methodname>stomp_commit</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
<methodparam><type>string</type><parameter>transaction_id</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>headers</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Commits a transaction in progress.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -34,9 +34,9 @@
<varlistentry>
<term><parameter>transaction_id</parameter></term>
<listitem>
<para>
<simpara>
The transaction id.
</para>
</simpara>
</listitem>
</varlistentry>
&stomp.param.headers;
@@ -45,9 +45,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

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

@@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (constructor):</para>
<simpara>&style.oop; (constructor):</simpara>
<constructorsynopsis>
<modifier>public</modifier> <methodname>Stomp::__construct</methodname>
<methodparam choice="opt"><type>string</type><parameter>broker</parameter><initializer>ini_get("stomp.default_broker_uri")</initializer></methodparam>
@@ -17,7 +17,7 @@
<methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>headers</parameter></methodparam>
</constructorsynopsis>
<para>&style.procedural;:</para>
<simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type>resource</type><methodname>stomp_connect</methodname>
<methodparam choice="opt"><type>string</type><parameter>broker</parameter><initializer>ini_get("stomp.default_broker_uri")</initializer></methodparam>
@@ -25,9 +25,9 @@
<methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>headers</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Opens a connection to a stomp compliant Message Broker.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -36,25 +36,25 @@
<varlistentry>
<term><parameter>broker</parameter></term>
<listitem>
<para>
<simpara>
The broker URI
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<para>
<simpara>
The username.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
<simpara>
The password.
</para>
</simpara>
</listitem>
</varlistentry>
&stomp.param.headers;

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

@@ -9,19 +9,19 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (destructor):</para>
<simpara>&style.oop; (destructor):</simpara>
<destructorsynopsis>
<modifier>public</modifier> <methodname>Stomp::__destruct</methodname>
<void/>
</destructorsynopsis>
<para>&style.procedural;:</para>
<simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type>bool</type><methodname>stomp_close</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Closes a previously opened connection.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -33,16 +33,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<simpara>
See <function>stomp_connect</function>.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

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

@@ -9,19 +9,19 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (method):</para>
<simpara>&style.oop; (method):</simpara>
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>Stomp::error</methodname>
<void/>
</methodsynopsis>
<para>&style.procedural;:</para>
<simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type>string</type><methodname>stomp_error</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Gets the last stomp error.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -33,9 +33,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an error string or &false; if no error occurred.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

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

@@ -9,19 +9,19 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (method):</para>
<simpara>&style.oop; (method):</simpara>
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>Stomp::getReadTimeout</methodname>
<void/>
</methodsynopsis>
<para>&style.procedural;:</para>
<simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type>array</type><methodname>stomp_get_read_timeout</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Gets read timeout
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -33,9 +33,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an array with 2 elements: sec and usec.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

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

@@ -9,19 +9,19 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (method):</para>
<simpara>&style.oop; (method):</simpara>
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>Stomp::getSessionId</methodname>
<void/>
</methodsynopsis>
<para>&style.procedural;:</para>
<simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>stomp_get_session_id</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Gets the current stomp session ID.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -33,9 +33,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&string; session id on success&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

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

@@ -9,19 +9,19 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (method):</para>
<simpara>&style.oop; (method):</simpara>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Stomp::hasFrame</methodname>
<void/>
</methodsynopsis>
<para>&style.procedural;:</para>
<simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type>bool</type><methodname>stomp_has_frame</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Indicates whether or not there is a frame ready to read.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -33,9 +33,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns &true; if a frame is ready to read, or &false; otherwise.
</para>
</simpara>
</refsect1>
</refentry>

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

@@ -9,19 +9,19 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (method):</para>
<simpara>&style.oop; (method):</simpara>
<methodsynopsis>
<modifier>public</modifier> <type>stompframe</type><methodname>Stomp::readFrame</methodname>
<methodparam choice="opt"><type>string</type><parameter>class_name</parameter><initializer>"stompFrame"</initializer></methodparam>
</methodsynopsis>
<para>&style.procedural;:</para>
<simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type>array</type><methodname>stomp_read_frame</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Reads the next frame. It is possible to instantiate an object of a specific class, and pass parameters to that class's constructor.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -31,9 +31,9 @@
<varlistentry>
<term><parameter>class_name</parameter></term>
<listitem>
<para>
<simpara>
The name of the class to instantiate. If not specified, a stompFrame object is returned.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>

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

@@ -9,14 +9,14 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (method):</para>
<simpara>&style.oop; (method):</simpara>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Stomp::send</methodname>
<methodparam><type>string</type><parameter>destination</parameter></methodparam>
<methodparam><type>mixed</type><parameter>msg</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>headers</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;:</para>
<simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type>bool</type><methodname>stomp_send</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
@@ -24,9 +24,9 @@
<methodparam><type>mixed</type><parameter>msg</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>headers</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Sends a message to the Message Broker.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -36,17 +36,17 @@
<varlistentry>
<term><parameter>destination</parameter></term>
<listitem>
<para>
<simpara>
Where to send the message
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>msg</parameter></term>
<listitem>
<para>
<simpara>
Message to send.
</para>
</simpara>
</listitem>
</varlistentry>
&stomp.param.headers;
@@ -55,16 +55,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<simpara>
See <function>stomp_ack</function>.
</para>
</simpara>
</refsect1>
<refsect1 role="notes">

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

@@ -9,22 +9,22 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (method):</para>
<simpara>&style.oop; (method):</simpara>
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Stomp::setReadTimeout</methodname>
<methodparam><type>int</type><parameter>seconds</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>microseconds</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;:</para>
<simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type>void</type><methodname>stomp_set_read_timeout</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
<methodparam><type>int</type><parameter>seconds</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>microseconds</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Sets read timeout.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -34,17 +34,17 @@
<varlistentry>
<term><parameter>seconds</parameter></term>
<listitem>
<para>
<simpara>
The seconds part of the timeout to be set.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>microseconds</parameter></term>
<listitem>
<para>
<simpara>
The microseconds part of the timeout to be set.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -52,9 +52,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

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

@@ -9,22 +9,22 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (method):</para>
<simpara>&style.oop; (method):</simpara>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Stomp::subscribe</methodname>
<methodparam><type>string</type><parameter>destination</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>headers</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;:</para>
<simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type>bool</type><methodname>stomp_subscribe</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
<methodparam><type>string</type><parameter>destination</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>headers</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Registers to listen to a given destination.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -34,9 +34,9 @@
<varlistentry>
<term><parameter>destination</parameter></term>
<listitem>
<para>
<simpara>
Destination to subscribe to.
</para>
</simpara>
</listitem>
</varlistentry>
&stomp.param.headers;
@@ -45,16 +45,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<simpara>
See <function>stomp_ack</function>.
</para>
</simpara>
</refsect1>
<refsect1 role="notes">

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

@@ -9,22 +9,22 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (method):</para>
<simpara>&style.oop; (method):</simpara>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Stomp::unsubscribe</methodname>
<methodparam><type>string</type><parameter>destination</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>headers</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;:</para>
<simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type>bool</type><methodname>stomp_unsubscribe</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
<methodparam><type>string</type><parameter>destination</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>headers</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Removes an existing subscription.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -34,9 +34,9 @@
<varlistentry>
<term><parameter>destination</parameter></term>
<listitem>
<para>
<simpara>
Subscription to remove.
</para>
</simpara>
</listitem>
</varlistentry>
&stomp.param.headers;
@@ -45,16 +45,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<simpara>
See <function>stomp_ack</function>.
</para>
</simpara>
</refsect1>
<refsect1 role="notes">

14
reference/stomp/stompexception.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.stompexception" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.stompexception" role="class">
<title>The StompException class</title>
<titleabbrev>StompException</titleabbrev>
@@ -11,9 +10,9 @@
<!-- {{{ StompException intro -->
<section xml:id="stompexception.intro">
&reftitle.intro;
<para>
<simpara>
Represents an error raised by the stomp extension. See <link linkend="language.exceptions">Exceptions</link> for more information about Exceptions in PHP.
</para>
</simpara>
</section>
<!-- }}} -->
@@ -29,7 +28,7 @@ Represents an error raised by the stomp extension. See <link linkend="language.e
<ooclass>
<classname>StompException</classname>
</ooclass>
<ooclass>
<modifier>extends</modifier>
<classname>Exception</classname>
@@ -38,10 +37,10 @@ Represents an error raised by the stomp extension. See <link linkend="language.e
<!-- }}} -->
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.stompexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.stompexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
</classsynopsis>
<!-- }}} -->
@@ -51,7 +50,6 @@ Represents an error raised by the stomp extension. See <link linkend="language.e
&reference.stomp.entities.stompexception;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/stomp/stompexception/getdetails.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="stomp.getdetails" 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.getdetails">
<refnamediv>
<refname>StompException::getDetails</refname>
<refpurpose>Get exception details</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>StompException::getDetails</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Get exception details.
</para>
<simpara>
Get exception details.
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,13 +24,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&string; containing the error details.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/stomp/stompframe.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.stompframe" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.stompframe" role="class">
<title>The StompFrame class</title>
<titleabbrev>StompFrame</titleabbrev>
@@ -11,9 +10,9 @@
<!-- {{{ StompFrame intro -->
<section xml:id="stompframe.intro">
&reftitle.intro;
<para>
<simpara>
Represents a message which was sent or received from a Stomp compliant Message Broker.
</para>
</simpara>
</section>
<!-- }}} -->
@@ -45,7 +44,7 @@
<varname linkend="stompframe.props.body">body</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.stompframe')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
</classsynopsis>
@@ -53,7 +52,7 @@
</section>
<!-- {{{ StompFrame properties -->
<section xml:id="stompframe.props">
&reftitle.properties;
@@ -61,19 +60,19 @@
<varlistentry xml:id="stompframe.props.command">
<term><varname>command</varname></term>
<listitem>
<para>Frame command.</para>
<simpara>Frame command.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="stompframe.props.headers">
<term><varname>headers</varname></term>
<listitem>
<para>Frame headers (&array;).</para>
<simpara>Frame headers (&array;).</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="stompframe.props.body">
<term><varname>body</varname></term>
<listitem>
<para>Frame body.</para>
<simpara>Frame body.</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -86,7 +85,6 @@
&reference.stomp.entities.stompframe;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

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

@@ -14,9 +14,9 @@
<methodparam choice="opt"><type>array</type><parameter>headers</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>body</parameter></methodparam>
</constructorsynopsis>
<para>
<simpara>
Constructor.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,25 +25,25 @@
<varlistentry>
<term><parameter>command</parameter></term>
<listitem>
<para>
<simpara>
Frame command
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>headers</parameter></term>
<listitem>
<para>
<simpara>
Frame headers (&array;).
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>body</parameter></term>
<listitem>
<para>
<simpara>
Frame body.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>