mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 22:08:55 +00:00
af4410a7e1
still using this, after discussion on the phpdoc list. From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
92 lines
2.8 KiB
XML
92 lines
2.8 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.hw-getremotechildren" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>hw_getremotechildren</refname>
|
|
<refpurpose>Gets children of remote document</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>mixed</type><methodname>hw_getremotechildren</methodname>
|
|
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>object_record</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns the children of a remote document. Children of a remote document
|
|
are remote documents itself. This makes sense if a database query has to
|
|
be narrowed and is explained in Hyperwave Programmers' Guide.
|
|
</para>
|
|
<para>
|
|
If you want to use this function you should be very familiar with HGIs.
|
|
You should also consider to use PHP instead of Hyperwave to access
|
|
external sources. Adding database support by a Hyperwave gateway should be
|
|
more difficult than doing it in PHP.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>connection</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The connection identifier.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>object_record</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The object record.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
If the number of children is 1 the function will return the document
|
|
itself formatted by the Hyperwave Gateway Interface (HGI). If the number
|
|
of children is greater than 1 it will return an array of object record
|
|
with each maybe the input value for another call to
|
|
<function>hw_getremotechildren</function>. Those object records are
|
|
virtual and do not exist in the Hyperwave server, therefore they do not
|
|
have a valid object ID. How exactly such an object record looks like is up
|
|
to the HGI.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>hw_getremote</function></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
|
|
-->
|