sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 16:38:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Switch to new doc style

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@249383 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-12-29 23:04:24 +00:00
parent f5eef30132
commit 7d46847705
23 changed files with 564 additions and 140 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
reference/array/functions/array-product.xml
View file

@ -1,20 +1,44 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.array-product" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>array_product</refname>
<refpurpose>Calculate the product of values in an array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>number</type><methodname>array_product</methodname>
<methodparam><type>array</type><parameter>array</parameter></methodparam>
</methodsynopsis>
<para>
<function>array_product</function> returns the product of values
in an array as an integer or float.
in an array.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
The array.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the product as an integer or float.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>array_product</function> examples</title>

38
reference/array/functions/array-values.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.12 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
<!-- $Revision: 1.13 $ -->
<refentry xml:id="function.array-values" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>array_values</refname>
<refpurpose>Return all the values of an array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>array_values</methodname>
<methodparam><type>array</type><parameter>input</parameter></methodparam>
@ -17,6 +16,30 @@
<parameter>input</parameter> array and indexes numerically the
array.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>input</parameter></term>
<listitem>
<para>
The array.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an indexed array of values.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>array_values</function> example</title>
@ -40,8 +63,13 @@ Array
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>array_keys</function>.
<simplelist>
<member><function>array_keys</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

47
reference/array/functions/end.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.14 $ -->
<!-- $Revision: 1.15 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
<refentry xml:id="function.end" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>end</refname>
<refpurpose>Set the internal pointer of an array to its last element</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>end</methodname>
<methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
@ -16,9 +16,33 @@
<function>end</function> advances <parameter>array</parameter>'s
internal pointer to the last element, and returns its value.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
The array.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the value of the last element.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A simple <function>end</function> example</title>
<title><function>end</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -31,12 +55,17 @@ echo end($fruits); // cranberry
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>current</function>,
<function>each</function>,
<function>prev</function>,
<function>next</function> and
<function>reset</function>.
<simplelist>
<member><function>current</function></member>
<member><function>each</function></member>
<member><function>prev</function></member>
<member><function>reset</function></member>
<member><function>next</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

42
reference/array/functions/key.xml
View file

@ -1,21 +1,45 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<!-- $Revision: 1.12 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
<refentry xml:id="function.key" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>key</refname>
<refpurpose>Fetch a key from an associative array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>key</methodname>
<methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
</methodsynopsis>
<para>
<function>key</function> returns the index element of the
current array position.
<function>key</function> returns the index element of the current array
position.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
The array.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the index.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>key</function> example</title>
@ -42,8 +66,14 @@ while ($fruit_name = current($array)) {
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>current</function> and <function>next</function>.
<simplelist>
<member><function>current</function></member>
<member><function>next</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

55
reference/array/functions/shuffle.xml
View file

@ -1,22 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.16 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
<!-- $Revision: 1.17 $ -->
<refentry xml:id="function.shuffle" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>shuffle</refname>
<refpurpose>Shuffle an array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>shuffle</methodname>
<methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
</methodsynopsis>
<para>
This function shuffles (randomizes the order of the elements in)
an array.
This function shuffles (randomizes the order of the elements in) an array.
</para>
&note.no-key-association;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
The array.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>shuffle</function> example</title>
@ -34,13 +55,23 @@ foreach ($numbers as $number) {
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&note.no-key-association;
&note.randomseed;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>arsort</function>, <function>asort</function>,
<function>ksort</function>, <function>rsort</function>,
<function>sort</function>, and <function>usort</function>.
<simplelist>
<member><function>arsort</function></member>
<member><function>asort</function></member>
<member><function>ksort</function></member>
<member><function>rsort</function></member>
<member><function>sort</function></member>
<member><function>usort</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

35
reference/hw/functions/hw-array2objrec.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.hw-array2objrec" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Array2Objrec</refname>
<refpurpose>Convert attributes from object array to object record</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>hw_array2objrec</methodname>
<methodparam><type>array</type><parameter>object_array</parameter></methodparam>
@ -17,8 +16,34 @@
Multiple attributes like 'Title' in different languages are treated
properly.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>hw_objrec2array</function>.
<variablelist>
<varlistentry>
<term><parameter>object_array</parameter></term>
<listitem>
<para>
The array.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an object record.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_objrec2array</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

7
reference/hw/functions/hw-changeobject.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id='function.hw-changeobject' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_changeobject</refname>
<refpurpose>Changes attributes of an object (obsolete)</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>hw_changeobject</methodname>
<methodparam><type>int</type><parameter>link</parameter></methodparam>

32
reference/hw/functions/hw-close.xml
View file

@ -1,21 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.hw-close" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Close</refname>
<refpurpose>Closes the Hyperwave connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>hw_close</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
Returns &false; if connection is not a valid connection index,
otherwise &true;. Closes down the connection to a Hyperwave server
with the given connection index.
Closes down the connection to a Hyperwave server.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>

75
reference/hw/functions/hw-connect.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.hw-connect" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Connect</refname>
<refpurpose>Opens a connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>hw_connect</methodname>
<methodparam><type>string</type><parameter>host</parameter></methodparam>
@ -16,20 +15,64 @@
<methodparam><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<para>
Opens a connection to a Hyperwave server and returns a connection
index on success, or &false; if the connection
could not be made. Each of the arguments should be a quoted string,
except for the port number. The <parameter>username</parameter> and
<parameter>password</parameter> arguments are
optional and can be left out. In such a case no identification with
the server will be done. It is similar to identify as user anonymous.
This function returns a connection
index that is needed by other Hyperwave functions. You can have
multiple connections open at once. Keep in mind, that the password
is not encrypted.
Opens a connection to a Hyperwave server.
You can have multiple connections open at once.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>hw_pconnect</function>.
<variablelist>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem>
<para>
The server host name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>port</parameter></term>
<listitem>
<para>
The server port number.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<para>
The Hyperwave user name. If ommited, no identification with the server
will be done. It is similar to identify as user anonymous.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The password for <parameter>username</parameter>.
Keep in mind, that the password is not encrypted.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a connection index on success, or &false; if the connection could
not be made.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_pconnect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

7
reference/hw/functions/hw-connection-info.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id='function.hw-connection-info' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_connection_info</refname>
<refpurpose>Prints information about the connection to Hyperwave server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>hw_connection_info</methodname>
<methodparam><type>int</type><parameter>link</parameter></methodparam>

40
reference/hw/functions/hw-docbyanchorobj.xml
View file

@ -1,21 +1,49 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.hw-docbyanchorobj" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_DocByAnchorObj</refname>
<refpurpose>Object record object belonging to anchor</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>hw_docbyanchorobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>anchorID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an th object record of the document to
which <parameter>anchorID</parameter> belongs.
Returns an th object record of the document to which
<parameter>anchorID</parameter> belongs.
</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>anchorID</parameter></term>
<listitem>
<para>
The anchor identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an object record.
</para>
</refsect1>
</refentry>

7
reference/hw/functions/hw-dummy.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id='function.hw-dummy' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_dummy</refname>
<refpurpose>Hyperwave dummy function</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>hw_dummy</methodname>
<methodparam><type>int</type><parameter>link</parameter></methodparam>

39
reference/hw/functions/hw-error.xml
View file

@ -1,20 +1,47 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.hw-error" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Error</refname>
<refpurpose>Error number</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>hw_error</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
Returns the last error number. If the return value is 0 no error has
occurred. The error relates to the last command.
Returns the last error number, for the last command.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the last error number or 0 if no error occured.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_errormsg</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

42
reference/hw/functions/hw-errormsg.xml
View file

@ -1,21 +1,49 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.hw-errormsg" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_ErrorMsg</refname>
<refpurpose>Returns error message</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>hw_errormsg</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
Returns a string containing the last error message or 'No Error'. If &false;
is returned, this function failed.
The message relates to the last command.
Returns a string containing the last error message related to the last
command.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a string containing the last error message or 'No Error'.
If &false; is returned, this function failed.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_error</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

39
reference/hw/functions/hw-getanchors.xml
View file

@ -1,21 +1,48 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.hw-getanchors" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetAnchors</refname>
<refpurpose>Object ids of anchors of document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>hw_getanchors</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of object ids with anchors of the document
with object ID <parameter>objectID</parameter>.
Returns an array of object ids with anchors of the specified document.
</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>objectID</parameter></term>
<listitem>
<para>
The document object id.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array of object ids.
</para>
</refsect1>
</refentry>

7
reference/hw/functions/hw-getrellink.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id='function.hw-getrellink' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_getrellink</refname>
<refpurpose>Get link from source to dest relative to rootid</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>hw_getrellink</methodname>
<methodparam><type>int</type><parameter>link</parameter></methodparam>

28
reference/hw/functions/hw-getusername.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.hw-getusername" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_getusername</refname>
<refpurpose>Name of currently logged in user</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>hw_getusername</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
@ -16,6 +15,27 @@
Returns the username of the connection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the username as a string.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

33
reference/hw/functions/hw-info.xml
View file

@ -1,21 +1,40 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.hw-info" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Info</refname>
<refpurpose>Info about connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>hw_info</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
Returns information about the current connection. The returned string
has the following format: &lt;Serverstring&gt;, &lt;Host&gt;,
&lt;Port&gt;, &lt;Username&gt;, &lt;Port of Client&gt;,
Returns information about the current connection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The returned string has the following format: &lt;Serverstring&gt;,
&lt;Host&gt;, &lt;Port&gt;, &lt;Username&gt;, &lt;Port of Client&gt;,
&lt;Byte swapping&gt;
</para>
</refsect1>

28
reference/hw/functions/hw-output-document.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.hw-output-document" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Output_Document</refname>
<refpurpose>Prints hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>hw_output_document</methodname>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
@ -20,6 +19,27 @@
also accepted. This is deprecated, however.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>hw_document</parameter></term>
<listitem>
<para>
The document identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

7
reference/hw/functions/hw-setlinkroot.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id='function.hw-setlinkroot' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_setlinkroot</refname>
<refpurpose>Set the id to which links are calculated</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>hw_setlinkroot</methodname>
<methodparam><type>int</type><parameter>link</parameter></methodparam>

7
reference/hw/functions/hw-stat.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id='function.hw-stat' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_stat</refname>
<refpurpose>Returns status string</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>hw_stat</methodname>
<methodparam><type>int</type><parameter>link</parameter></methodparam>

43
reference/hw/functions/hw-unlock.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.hw-unlock" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Unlock</refname>
<refpurpose>Unlock object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>hw_unlock</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
@ -16,8 +15,42 @@
<para>
Unlocks a document, so other users regain access.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>hw_getandlock</function>.
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>objectID</parameter></term>
<listitem>
<para>
The document object identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_getandlock</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

14
reference/strings/functions/htmlspecialchars.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.11 $ -->
<!-- $Revision: 1.12 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.htmlspecialchars" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>htmlspecialchars</refname>
<refpurpose>Convert special characters to HTML entities</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>htmlspecialchars</methodname>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
@ -27,7 +27,7 @@
<simpara>
This function is useful in preventing user-supplied text from
containing HTML markup, such as in a message board or guest book
application.
application.
</simpara>
<para>
The translations performed are:
@ -93,7 +93,7 @@
<term><parameter>charset</parameter></term>
<listitem>
<para>
Defines character set used in conversion.
Defines character set used in conversion.
The default character set is ISO-8859-1.
</para>
&reference.strings.charsets;
@ -111,7 +111,7 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@ -182,7 +182,7 @@ echo $new; // &lt;a href=&#039;test&#039;&gt;Test&lt;/a&gt;
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>