mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
ref.hwapi: new doc style
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@237857 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
parent
3204cead04
commit
12dfe282af
53 changed files with 2267 additions and 741 deletions
|
@ -1,24 +1,41 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-attribute-key">
|
||||
<refnamediv>
|
||||
<refname>hw_api_attribute->key</refname>
|
||||
<refpurpose>Returns key of the attribute</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>hw_api_attribute->key</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api_attribute</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>key</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Returns the name of the attribute.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
See also <function>hwapi_attribute_value</function>.
|
||||
Returns the name of the attribute as a string.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-attribute-value" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,24 +1,56 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<refentry id="function.hwapi-attribute-langdepvalue">
|
||||
<refnamediv>
|
||||
<refname>hw_api_attribute->langdepvalue</refname>
|
||||
<refpurpose>Returns value for a given language</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>hw_api_attribute->langdepvalue</methodname>
|
||||
<methodparam><type>string</type><parameter>language</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api_attribute</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>langdepvalue</methodname>
|
||||
<methodparam><type>string</type><parameter>language</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Returns the value in the given language of the attribute.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
See also <function>hwapi_attribute_value</function>.
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>language</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the value of the attribute as a string.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-attribute-value" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,25 +1,42 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-attribute-value">
|
||||
<refnamediv>
|
||||
<refname>hw_api_attribute->value</refname>
|
||||
<refpurpose>Returns value of the attribute</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>hw_api_attribute->value</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api_attribute</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>value</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Returns the value of the attribute.
|
||||
</para>
|
||||
<para>
|
||||
See also <function>hwapi_attribute_key</function>,
|
||||
<function>hwapi_attribute_values</function>.
|
||||
Gets the value of the attribute.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the value, as a string.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-attribute-key" /></member>
|
||||
<member><xref linkend="function.hwapi-attribute-values" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,24 +1,41 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-attribute-values">
|
||||
<refnamediv>
|
||||
<refname>hw_api_attribute->values</refname>
|
||||
<refpurpose>Returns all values of the attribute</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>hw_api_attribute->values</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api_attribute</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>values</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Returns all values of the attribute as an array of strings.
|
||||
</para>
|
||||
<para>
|
||||
See also <function>hwapi_attribute_value</function>.
|
||||
Gets all values of the attribute.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns an array of attribute values.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-attribute-value" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-attribute">
|
||||
<refnamediv>
|
||||
<refname>hw_api_attribute</refname>
|
||||
<refpurpose>Creates instance of class hw_api_attribute</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>HW_API_Attribute</type><methodname>hw_api_attribute</methodname>
|
||||
<methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
|
||||
|
@ -17,6 +17,38 @@
|
|||
Creates a new instance of hw_api_attribute with the given name and value.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>name</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The attribute name.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>value</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The attribute value.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns an instance of <classname>hw_api_attribute</classname>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,17 +1,20 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.9 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.10 $ -->
|
||||
<refentry id="function.hwapi-checkin">
|
||||
<refnamediv>
|
||||
<refname>hw_api->checkin</refname>
|
||||
<refpurpose>Checks in an object</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>hw_api->checkin</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>checkin</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
This function checks in an object or a whole hierarchy of objects.
|
||||
The parameters array contains the required element
|
||||
|
@ -75,10 +78,39 @@
|
|||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
See also <function>hwapi_checkout</function>.
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-checkout" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,47 +1,79 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.9 $ -->
|
||||
<refentry id="function.hwapi-checkout">
|
||||
<refnamediv>
|
||||
<refname>hw_api->checkout</refname>
|
||||
<refpurpose>Checks out an object</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>hw_api->checkout</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>checkout</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
This function checks out an object or a whole hierarchy of objects.
|
||||
The parameters array contains the required element
|
||||
'objectIdentifier' and the optional element 'version', 'mode'
|
||||
and 'objectQuery'. 'mode' can be one of the following values:
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_CHECKIN_NORMAL</constant></term>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
Checks out an object. The object must be a document.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_CHECKIN_RECURSIVE</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
If the object to check out is a collection, all children will be
|
||||
checked out recursively if they are documents. Trying to check out
|
||||
a collection would result in an error.
|
||||
</simpara>
|
||||
<para>
|
||||
The parameters array contains the required element
|
||||
'objectIdentifier' and the optional element 'version', 'mode'
|
||||
and 'objectQuery'. 'mode' can be one of the following values:
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_CHECKIN_NORMAL</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
Checks out an object. The object must be a document.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_CHECKIN_RECURSIVE</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
If the object to check out is a collection, all children will be
|
||||
checked out recursively if they are documents. Trying to check out
|
||||
a collection would result in an error.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
See also <function>hwapi_checkin</function>.
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-checkin" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,33 +1,61 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<refentry id="function.hwapi-children">
|
||||
<refnamediv>
|
||||
<refname>hw_api->children</refname>
|
||||
<refpurpose>Returns children of an object</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>hw_api->children</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>children</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Retrieves the children of a collection or the attributes of a document.
|
||||
The children can be further filtered by specifying an object query.
|
||||
The parameter array
|
||||
contains the required elements 'objectIdentifier' and the optional
|
||||
elements 'attributeSelector' and 'objectQuery'.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The parameter array contains the required elements 'objectIdentifier'
|
||||
and the optional elements 'attributeSelector' and 'objectQuery'.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
The return value is an array of objects of type
|
||||
<classname>HW_API_Object</classname> or
|
||||
<classname>HW_API_Error</classname>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
See also <function>hwapi_parents</function>.
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-parents" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,21 +1,32 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-content-mimetype">
|
||||
<refnamediv>
|
||||
<refname>hw_api_content->mimetype</refname>
|
||||
<refpurpose>Returns mimetype</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>hw_api_content->mimetype</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api_content</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>mimetype</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Returns the mimetype of the content.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the mimetype as a string.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,23 +1,57 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-content-read">
|
||||
<refnamediv>
|
||||
<refname>hw_api_content->read</refname>
|
||||
<refpurpose>Read content</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>hw_api_content->read</methodname>
|
||||
<methodparam><type>string</type><parameter>buffer</parameter></methodparam>
|
||||
<methodparam><type>int</type><parameter>len</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api_content</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>read</methodname>
|
||||
<methodparam><type>string</type><parameter>buffer</parameter></methodparam>
|
||||
<methodparam><type>int</type><parameter>len</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Reads <parameter>len</parameter> bytes from the content into the given
|
||||
buffer.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>buffer</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>len</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Number of bytes to read.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,33 +1,63 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-content">
|
||||
<refnamediv>
|
||||
<refname>hw_api->content</refname>
|
||||
<refpurpose>Returns content of an object</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>HW_API_Content</type><methodname>hw_api->content</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>HW_API_Content</type><methodname>content</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
This function returns the content of a document as an object of type
|
||||
<classname>hw_api_content</classname>. The parameter array
|
||||
contains the required elements 'objectidentifier' and the optional
|
||||
element 'mode'. The mode can be one of the constants
|
||||
<constant>HW_API_CONTENT_ALLLINKS</constant>,
|
||||
<constant>HW_API_CONTENT_REACHABLELINKS</constant> or
|
||||
<constant>HW_API_CONTENT_PLAIN</constant>.
|
||||
<constant>HW_API_CONTENT_ALLLINKS</constant> means to insert all
|
||||
anchors even if the destination is not reachable.
|
||||
<constant>HW_API_CONTENT_REACHABLELINKS</constant> tells
|
||||
<function>hw_api_content</function> to insert only reachable links and
|
||||
<constant>HW_API_CONTENT_PLAIN</constant> will lead to
|
||||
document without any links.
|
||||
<classname>hw_api_content</classname>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The parameter array contains the required elements 'objectidentifier'
|
||||
and the optional element 'mode'. The mode can be one of the constants
|
||||
<constant>HW_API_CONTENT_ALLLINKS</constant>,
|
||||
<constant>HW_API_CONTENT_REACHABLELINKS</constant> or
|
||||
<constant>HW_API_CONTENT_PLAIN</constant>.
|
||||
</para>
|
||||
<para>
|
||||
<constant>HW_API_CONTENT_ALLLINKS</constant> means to insert all
|
||||
anchors even if the destination is not reachable.
|
||||
</para>
|
||||
<para>
|
||||
<constant>HW_API_CONTENT_REACHABLELINKS</constant> tells this method
|
||||
to insert only reachable links and
|
||||
<constant>HW_API_CONTENT_PLAIN</constant> will lead to document
|
||||
without any links.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns an instance of <classname>hw_api_content</classname>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,29 +1,61 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-copy">
|
||||
<refnamediv>
|
||||
<refname>hw_api->copy</refname>
|
||||
<refpurpose>Copies physically</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>hw_api->copy</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_content</type><methodname>copy</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
This function will make a physical copy including the content if it
|
||||
exists and returns the new object or an error object.
|
||||
The parameter array contains the
|
||||
required elements 'objectIdentifier' and 'destinationParentIdentifier'.
|
||||
The optional parameter is 'attributeSelector'`
|
||||
</para>
|
||||
<para>
|
||||
See also <function>hwapi_move</function>,
|
||||
<function>hwapi_link</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The parameter array contains the required elements 'objectIdentifier'
|
||||
and 'destinationParentIdentifier'. The optional parameter is
|
||||
'attributeSelector'`
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the copied object.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-move" /></member>
|
||||
<member><xref linkend="function.hwapi-link" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,25 +1,58 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-dbstat">
|
||||
<refnamediv>
|
||||
<refname>hw_api->dbstat</refname>
|
||||
<refpurpose>Returns statistics about database server</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>hw_api->dbstat</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>dbstat</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
</para>
|
||||
<para>
|
||||
See also <function>hwapi_dcstat</function>,
|
||||
<function>hwapi_hwstat</function>,
|
||||
<function>hwapi_ftstat</function>.
|
||||
Returns statistics about database server.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-dcstat" /></member>
|
||||
<member><xref linkend="function.hwapi-hwstat" /></member>
|
||||
<member><xref linkend="function.hwapi-ftstat" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,25 +1,58 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-dcstat">
|
||||
<refnamediv>
|
||||
<refname>hw_api->dcstat</refname>
|
||||
<refpurpose>Returns statistics about document cache server</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>hw_api->dcstat</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>dcstat</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
</para>
|
||||
<para>
|
||||
See also <function>hwapi_hwstat</function>,
|
||||
<function>hwapi_dbstat</function>,
|
||||
<function>hwapi_ftstat</function>.
|
||||
Returns statistics about document cache server.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-dbstat" /></member>
|
||||
<member><xref linkend="function.hwapi-hwstat" /></member>
|
||||
<member><xref linkend="function.hwapi-ftstat" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,27 +1,58 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-dstanchors">
|
||||
<refnamediv>
|
||||
<refname>hw_api->dstanchors</refname>
|
||||
<refpurpose>Returns a list of all destination anchors</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>hw_api->dstanchors</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>dstanchors</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Retrieves all destination anchors of an object. The parameter array
|
||||
contains
|
||||
the required element 'objectIdentifier' and the optional elements
|
||||
'attributeSelector' and 'objectQuery'.
|
||||
</para>
|
||||
<para>
|
||||
See also <function>hwapi_srcanchors</function>.
|
||||
Retrieves all destination anchors of an object.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The parameter array contains the required element 'objectIdentifier'
|
||||
and the optional elements 'attributeSelector' and 'objectQuery'.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-srcanchors" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,29 +1,62 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<refentry id="function.hwapi-dstofsrcanchor">
|
||||
<refnamediv>
|
||||
<refname>hw_api->dstofsrcanchor</refname>
|
||||
<refpurpose>Returns destination of a source anchor</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>hw_api->dstofsrcanchor</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>dstofsrcanchor</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Retrieves the destination object pointed by the specified source anchors.
|
||||
The destination object can either be a destination anchor or a whole
|
||||
document. The parameters array contains the required element
|
||||
'objectIdentifier' and the optional element 'attributeSelector'.
|
||||
</para>
|
||||
<para>
|
||||
See also <function>hwapi_srcanchors</function>,
|
||||
<function>hwapi_dstanchors</function>,
|
||||
<function>hwapi_objectbyanchor</function>.
|
||||
document.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The parameters array contains the required element 'objectIdentifier'
|
||||
and the optional element 'attributeSelector'.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-srcanchors" /></member>
|
||||
<member><xref linkend="function.hwapi-dstanchors" /></member>
|
||||
<member><xref linkend="function.hwapi-objectbyanchor" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,24 +1,41 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-error-count">
|
||||
<refnamediv>
|
||||
<refname>hw_api_error->count</refname>
|
||||
<refpurpose>Returns number of reasons</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>hw_api_error->count</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api_error</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>count</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Returns the number of error reasons.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
See also <function>hwapi_error_reason</function>.
|
||||
Returns the number of errors, as an integer.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-error-reason" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,24 +1,41 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.9 $ -->
|
||||
<refentry id="function.hwapi-error-reason">
|
||||
<refnamediv>
|
||||
<refname>hw_api_error->reason</refname>
|
||||
<refpurpose>Returns reason of error</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>HW_API_Reason</type><methodname>hw_api_error->reason</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api_error</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>HW_API_Reason</type><methodname>reason</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Returns the first error reason.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
See also <function>hwapi_error_count</function>.
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-error-count" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,17 +1,20 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-find">
|
||||
<refnamediv>
|
||||
<refname>hw_api->find</refname>
|
||||
<refpurpose>Search for objects</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>hw_api->find</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>find</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
This functions searches for objects either by executing a key or/and full
|
||||
text query. The found objects can further be filtered by an optional
|
||||
|
@ -19,13 +22,37 @@
|
|||
operation is relatively slow and its result can be limited to a certain
|
||||
number of hits. This allows to perform an incremental search, each
|
||||
returning just a subset of all found documents, starting at a given
|
||||
index. The parameter array contains the 'keyquery' or/and 'fulltextquery'
|
||||
depending on who you would like to search. Optional parameters are
|
||||
'objectquery', 'scope', 'languages' and 'attributeselector'. In case of
|
||||
an incremental search the optional parameters 'startIndex',
|
||||
numberOfObjectsToGet' and 'exactMatchUnit' can be passed.
|
||||
index.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The parameter array contains the 'keyquery' or/and 'fulltextquery'
|
||||
depending on who you would like to search. Optional parameters are
|
||||
'objectquery', 'scope', 'languages' and 'attributeselector'. In case
|
||||
of an incremental search the optional parameters 'startIndex',
|
||||
'numberOfObjectsToGet' and 'exactMatchUnit' can be passed.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,25 +1,58 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-ftstat">
|
||||
<refnamediv>
|
||||
<refname>hw_api->ftstat</refname>
|
||||
<refpurpose>Returns statistics about fulltext server</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>hw_api->ftstat</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>ftstat</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
</para>
|
||||
<para>
|
||||
See also <function>hwapi_dcstat</function>,
|
||||
<function>hwapi_dbstat</function>,
|
||||
<function>hwapi_hwstat</function>.
|
||||
Returns statistics about fulltext server.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-dcstat" /></member>
|
||||
<member><xref linkend="function.hwapi-dbstat" /></member>
|
||||
<member><xref linkend="function.hwapi-hwstat" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<refentry id="function.hwapi-hgcsp">
|
||||
<refnamediv>
|
||||
<refname>hwapi_hgcsp</refname>
|
||||
<refpurpose>Returns object of class hw_api</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>HW_API</type><methodname>hwapi_hgcsp</methodname>
|
||||
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
|
||||
|
@ -16,12 +16,40 @@
|
|||
<para>
|
||||
Opens a connection to the Hyperwave server on host
|
||||
<parameter>hostname</parameter>. The protocol used is HGCSP.
|
||||
If you do not pass a port number, 418 is used.
|
||||
</para>
|
||||
<para>
|
||||
See also <function>hwapi_hwtp</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>hostname</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The host name.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>port</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
If you do not pass a port number, 418 is used.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns an instance of <classname>HW_API</classname>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,25 +1,58 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-hwstat">
|
||||
<refnamediv>
|
||||
<refname>hw_api->hwstat</refname>
|
||||
<refpurpose>Returns statistics about Hyperwave server</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>hw_api->hwstat</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>hwstat</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
</para>
|
||||
<para>
|
||||
See also <function>hwapi_dcstat</function>,
|
||||
<function>hwapi_dbstat</function>,
|
||||
<function>hwapi_ftstat</function>.
|
||||
Returns statistics about Hyperwave server.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-dcstat" /></member>
|
||||
<member><xref linkend="function.hwapi-dbstat" /></member>
|
||||
<member><xref linkend="function.hwapi-ftstat" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,27 +1,50 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.9 $ -->
|
||||
<refentry id="function.hwapi-identify">
|
||||
<refnamediv>
|
||||
<refname>hw_api->identify</refname>
|
||||
<refpurpose>Log into Hyperwave Server</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>hw_api->identify</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>identify</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Logs into the Hyperwave Server. The parameter array must contain the
|
||||
elements 'username' and 'password'.
|
||||
</para>
|
||||
<para>
|
||||
The return value will be an object of type
|
||||
<classname>HW_API_Error</classname> if identification failed or TRUE
|
||||
if it was successful.
|
||||
Logs into the Hyperwave Server.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The parameter array must contain the elements 'username' and
|
||||
'password'.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns an object of type<classname>HW_API_Error</classname> if
|
||||
identification failed or &true; if it was successful.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,26 +1,59 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-info">
|
||||
<refnamediv>
|
||||
<refname>hw_api->info</refname>
|
||||
<refpurpose>Returns information about server configuration</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>hw_api->info</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>info</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
</para>
|
||||
<para>
|
||||
See also <function>hwapi_dcstat</function>,
|
||||
<function>hwapi_dbstat</function>,
|
||||
<function>hwapi_ftstat</function>,
|
||||
<function>hwapi_hwstat</function>.
|
||||
Returns information about server configuration.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-dcstat" /></member>
|
||||
<member><xref linkend="function.hwapi-dbstat" /></member>
|
||||
<member><xref linkend="function.hwapi-ftstat" /></member>
|
||||
<member><xref linkend="function.hwapi-hwstat" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,77 +1,109 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.9 $ -->
|
||||
<refentry id="function.hwapi-insert">
|
||||
<refnamediv>
|
||||
<refname>hw_api->insert</refname>
|
||||
<refpurpose>Inserts a new object</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>hw_api->insert</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>insert</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Insert a new object. The object type can be user, group, document or
|
||||
anchor. Depending on the type other object attributes has to be set.
|
||||
The parameter array contains the required elements 'object' and 'content'
|
||||
(if the object is a document) and the optional parameters 'parameters',
|
||||
'mode' and 'attributeSelector'. The 'object' must contain all attributes
|
||||
of the object. 'parameters' is an object as well holding further
|
||||
attributes like the destination (attribute key is 'Parent'). 'content' is
|
||||
the content of the document. 'mode' can be a
|
||||
combination of the following flags:
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_INSERT_NORMAL</constant></term>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
The object in inserted into the server.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_INSERT_FORCE_VERSION_CONTROL</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_INSERT_AUTOMATIC_CHECKOUT</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_INSERT_PLAIN</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_INSERT_KEEP_TIME_MODIFIED</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_INSERT_DELAY_INDEXING</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
</simpara>
|
||||
<para>
|
||||
The parameter array contains the required elements 'object' and 'content'
|
||||
(if the object is a document) and the optional parameters 'parameters',
|
||||
'mode' and 'attributeSelector'. The 'object' must contain all attributes
|
||||
of the object. 'parameters' is an object as well holding further
|
||||
attributes like the destination (attribute key is 'Parent'). 'content' is
|
||||
the content of the document. 'mode' can be a
|
||||
combination of the following flags:
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_INSERT_NORMAL</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
The object in inserted into the server.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_INSERT_FORCE_VERSION_CONTROL</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_INSERT_AUTOMATIC_CHECKOUT</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_INSERT_PLAIN</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_INSERT_KEEP_TIME_MODIFIED</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_INSERT_DELAY_INDEXING</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
See also <function>hwapi_replace</function>.
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-replace" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,37 +1,68 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-insertanchor">
|
||||
<refnamediv>
|
||||
<refname>hw_api->insertanchor</refname>
|
||||
<refpurpose>Inserts a new object of type anchor</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>hw_api->insertanchor</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>insertanchor</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
This function is a shortcut for <function>hwapi_insert</function>. It
|
||||
inserts an object of type anchor and sets some of the attributes
|
||||
required
|
||||
for an anchor. The parameter array contains the required elements
|
||||
'object' and 'documentIdentifier' and the optional elements
|
||||
'destinationIdentifier', 'parameter', 'hint' and 'attributeSelector'.
|
||||
The 'documentIdentifier'
|
||||
specifies the document where the anchor shall be inserted. The target of
|
||||
the anchor is set in 'destinationIdentifier' if it already exists. If the
|
||||
target does not exists the element 'hint' has to be set to the name of
|
||||
object which is supposed to be inserted later. Once it is inserted the
|
||||
anchor target is resolved automatically.
|
||||
</para>
|
||||
<para>
|
||||
See also <function>hwapi_insertdocument</function>,
|
||||
<function>hwapi_insertcollection</function>,
|
||||
<function>hwapi_insert</function>.
|
||||
required for an anchor.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The parameter array contains the required elements 'object' and
|
||||
'documentIdentifier' and the optional elements 'destinationIdentifier',
|
||||
'parameter', 'hint' and 'attributeSelector'. The 'documentIdentifier'
|
||||
specifies the document where the anchor shall be inserted. The target
|
||||
of the anchor is set in 'destinationIdentifier' if it already exists.
|
||||
If the target does not exists the element 'hint' has to be set to the
|
||||
name of object which is supposed to be inserted later. Once it is
|
||||
inserted the anchor target is resolved automatically.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-insert" /></member>
|
||||
<member><xref linkend="function.hwapi-insertdocument" /></member>
|
||||
<member><xref linkend="function.hwapi-insertcollection" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,32 +1,64 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-insertcollection">
|
||||
<refnamediv>
|
||||
<refname>hw_api->insertcollection</refname>
|
||||
<refpurpose>Inserts a new object of type collection</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>hw_api->insertcollection</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>insertcollection</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
This function is a shortcut for <function>hwapi_insert</function>. It
|
||||
inserts an object of type collection and sets some of the attributes
|
||||
required
|
||||
for a collection. The parameter array contains the required elements
|
||||
'object' and 'parentIdentifier' and the optional elements
|
||||
'parameter' and 'attributeSelector'. See
|
||||
<function>hwapi_insert</function> for the meaning of each element.
|
||||
</para>
|
||||
<para>
|
||||
See also <function>hwapi_insertdocument</function>,
|
||||
<function>hwapi_insertanchor</function> and
|
||||
<function>hwapi_insert</function>.
|
||||
required for a collection.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The parameter array contains the required elements 'object' and
|
||||
'parentIdentifier' and the optional elements 'parameter' and
|
||||
'attributeSelector'. See <function>hwapi_insert</function> for the
|
||||
meaning of each element.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-insert" /></member>
|
||||
<member><xref linkend="function.hwapi-insertdocument" /></member>
|
||||
<member><xref linkend="function.hwapi-insertanchor" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,31 +1,66 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-insertdocument">
|
||||
<refnamediv>
|
||||
<refname>hw_api->insertdocument</refname>
|
||||
<refpurpose>Inserts a new object of type document</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>hw_api->insertdocument</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>insertdocument</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
This function is a shortcut for <function>hwapi_insert</function>. It
|
||||
inserts an object with content and sets some of the attributes required
|
||||
for a document. The parameter array contains the required elements
|
||||
'object', 'parentIdentifier' and 'content' and the optional elements
|
||||
'mode', 'parameter' and 'attributeSelector'. See
|
||||
<function>hwapi_insert</function> for the meaning of each element.
|
||||
</para>
|
||||
<para>
|
||||
See also <function>hwapi_insert</function>,
|
||||
<function>hwapi_insertanchor</function> and
|
||||
<function>hwapi_insertcollection</function>.
|
||||
for a document.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The parameter array contains the required elements 'object',
|
||||
'parentIdentifier' and 'content' and the optional elements 'mode',
|
||||
'parameter' and 'attributeSelector'.
|
||||
</para>
|
||||
<para>
|
||||
See <function>hwapi_insert</function> for the meaning of each element.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-insert" /></member>
|
||||
<member><xref linkend="function.hwapi-insertcollection" /></member>
|
||||
<member><xref linkend="function.hwapi-insertanchor" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,30 +1,60 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.9 $ -->
|
||||
<refentry id="function.hwapi-link">
|
||||
<refnamediv>
|
||||
<refname>hw_api->link</refname>
|
||||
<refpurpose>Creates a link to an object</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>hw_api->link</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>link</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Creates a link to an object. Accessing this link is like accessing the
|
||||
object to links points to. The parameter array contains the required
|
||||
elements 'objectIdentifier' and 'destinationParentIdentifier'.
|
||||
'destinationParentIdentifier' is the target collection.
|
||||
object to links points to.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The parameter array contains the required elements 'objectIdentifier'
|
||||
and 'destinationParentIdentifier'. 'destinationParentIdentifier' is
|
||||
the target collection.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
The function returns &true; on success or an error object.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
See also <function>hwapi_copy</function>.
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-copy" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,35 +1,68 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.9 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.10 $ -->
|
||||
<refentry id="function.hwapi-lock">
|
||||
<refnamediv>
|
||||
<refname>hw_api->lock</refname>
|
||||
<refpurpose>Locks an object</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>hw_api->lock</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>lock</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Locks an object for exclusive editing by the user calling this function.
|
||||
The object can be only unlocked by this user or the system user. The
|
||||
parameter array contains the required element 'objectIdentifier' and the
|
||||
optional parameters 'mode' and 'objectquery'.
|
||||
'mode' determines how an object is locked.
|
||||
<constant>HW_API_LOCK_NORMAL</constant> means,
|
||||
an object is locked until it is unlocked.
|
||||
<constant>HW_API_LOCK_RECURSIVE</constant>
|
||||
is only valid for collection and locks all objects
|
||||
within the collection and possible subcollections.
|
||||
<constant>HW_API_LOCK_SESSION</constant> means, an
|
||||
object is locked only as long as the session is valid.
|
||||
</para>
|
||||
<para>
|
||||
See also <function>hwapi_unlock</function>.
|
||||
The object can be only unlocked by this user or the system user.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The parameter array contains the required element 'objectIdentifier'
|
||||
and the optional parameters 'mode' and 'objectquery'.
|
||||
</para>
|
||||
<para>
|
||||
'mode' determines how an object is locked.
|
||||
<constant>HW_API_LOCK_NORMAL</constant> means, an object is locked
|
||||
until it is unlocked. <constant>HW_API_LOCK_RECURSIVE</constant> is
|
||||
only valid for collection and locks all objects within the collection
|
||||
and possible subcollections. <constant>HW_API_LOCK_SESSION</constant>
|
||||
means, an object is locked only as long as the session is valid.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-unlock" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,23 +1,56 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-move">
|
||||
<refnamediv>
|
||||
<refname>hw_api->move</refname>
|
||||
<refpurpose>Moves object between collections</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>hw_api->move</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>move</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
</para>
|
||||
<para>
|
||||
See also <function>hw_objrec2array</function>.
|
||||
Moves object between collections.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</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_objrec2array</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-new-content">
|
||||
<refnamediv>
|
||||
<refname>hw_api_content</refname>
|
||||
<refpurpose>Create new instance of class hw_api_content</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>HW_API_Content</type><methodname>hw_api_content</methodname>
|
||||
<methodparam><type>string</type><parameter>content</parameter></methodparam>
|
||||
|
@ -15,10 +15,40 @@
|
|||
</methodsynopsis>
|
||||
<para>
|
||||
Creates a new content object from the string
|
||||
<parameter>content</parameter>. The mimetype is set to
|
||||
<parameter>mimetype</parameter>.
|
||||
<parameter>content</parameter>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>content</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>mimetype</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The mimetype for the contents.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,21 +1,47 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-object-assign">
|
||||
<refnamediv>
|
||||
<refname>hw_api_object->assign</refname>
|
||||
<refpurpose>Clones object</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>hw_api_object->assign</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api_object</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>assign</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Clones the attributes of an object.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</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
|
||||
|
|
|
@ -1,20 +1,47 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<refentry id="function.hwapi-object-attreditable">
|
||||
<refnamediv>
|
||||
<refname>hw_api_object->attreditable</refname>
|
||||
<refpurpose>Checks whether an attribute is editable</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>hw_api_object->attreditable</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api_object</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>attreditable</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Checks whether an attribute is editable.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns &true; if the attribute is editable, &false; otherwise.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,20 +1,47 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<refentry id="function.hwapi-object-count">
|
||||
<refnamediv>
|
||||
<refname>hw_api_object->count</refname>
|
||||
<refpurpose>Returns number of attributes</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>hw_api_object->count</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api_object</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>count</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Returns the number of attributes.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the number as an integer.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,25 +1,56 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.9 $ -->
|
||||
<refentry id="function.hwapi-object-insert">
|
||||
<refnamediv>
|
||||
<refname>hw_api_object->insert</refname>
|
||||
<refpurpose>Inserts new attribute</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>hw_api_object->insert</methodname>
|
||||
<methodparam><type>HW_API_Attribute</type><parameter>attribute</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api_object</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>insert</methodname>
|
||||
<methodparam><type>HW_API_Attribute</type><parameter>attribute</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Adds an attribute to the object. Returns &true; on success and otherwise
|
||||
&false;.
|
||||
</para>
|
||||
<para>
|
||||
See also <function>hwapi_object_remove</function>.
|
||||
Adds an attribute to the object.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>attribute</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-object-remove" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,21 +1,53 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<refentry id="function.hwapi-object-new">
|
||||
<refnamediv>
|
||||
<refname>hw_api_object</refname>
|
||||
<refpurpose>Creates a new instance of class hw_api_object</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>hw_api_object</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
See also <function>hwapi_lock</function>.
|
||||
Creates a new instance of the class <classname>hw_api_object</classname>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-lock" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,25 +1,57 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-object-remove">
|
||||
<refnamediv>
|
||||
<refname>hw_api_object->remove</refname>
|
||||
<refpurpose>Removes attribute</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>hw_api_object->remove</methodname>
|
||||
<methodparam><type>string</type><parameter>name</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api_object</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>remove</methodname>
|
||||
<methodparam><type>string</type><parameter>name</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Removes the attribute with the given name. Returns &true; on success
|
||||
and otherwise &false;.
|
||||
</para>
|
||||
<para>
|
||||
See also <function>hwapi_object_insert</function>.
|
||||
Removes the attribute with the given name.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>name</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The attribute name.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-object-insert" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,20 +1,47 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<refentry id="function.hwapi-object-title">
|
||||
<refnamediv>
|
||||
<refname>hw_api_object->title</refname>
|
||||
<refpurpose>Returns the title attribute</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>hw_api_object->title</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api_object</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>title</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Returns the title attribute.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the title as a string.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,22 +1,49 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.9 $ -->
|
||||
<refentry id="function.hwapi-object-value">
|
||||
<refnamediv>
|
||||
<refname>hw_api_object->value</refname>
|
||||
<refpurpose>Returns value of attribute</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>hw_api_object->value</methodname>
|
||||
<methodparam><type>string</type><parameter>name</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api_object</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>value</methodname>
|
||||
<methodparam><type>string</type><parameter>name</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Returns value of an attribute.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>name</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The attribute name.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the value of the attribute with the given name or &false; if an
|
||||
error occurred.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,28 +1,54 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.11 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.12 $ -->
|
||||
<refentry id="function.hwapi-object">
|
||||
<refnamediv>
|
||||
<refname>hw_api->object</refname>
|
||||
<refpurpose>Retrieve attribute information</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>hw_api->object</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>object</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
This function retrieves the attribute information of an object of any
|
||||
version. It will not return the document content. The parameter array
|
||||
contains the required elements 'objectIdentifier' and the optional
|
||||
elements 'attributeSelector' and 'version'.
|
||||
version. It will not return the document content.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The parameter array contains the required elements 'objectIdentifier'
|
||||
and the optional elements 'attributeSelector' and 'version'.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
The returned object is an instance of class
|
||||
<classname>HW_API_Object</classname> on success or
|
||||
<classname>HW_API_Error</classname> if an error occurred.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
This simple example retrieves an object and checks for errors.
|
||||
<example>
|
||||
|
@ -74,10 +100,17 @@ list_attr($root);
|
|||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
See also <function>hwapi_content</function>.
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-content" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,27 +1,60 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-objectbyanchor">
|
||||
<refnamediv>
|
||||
<refname>hw_api->objectbyanchor</refname>
|
||||
<refpurpose>Returns the object an anchor belongs to</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>hw_api->objectbyanchor</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>objectbyanchor</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
This function retrieves an object the specified anchor belongs to.
|
||||
The parameter array contains the required element 'objectIdentifier' and
|
||||
the optional element 'attributeSelector'.
|
||||
</para>
|
||||
<para>
|
||||
See also <function>hwapi_dstofsrcanchor</function>,
|
||||
<function>hwapi_srcanchors</function> and <function>hwapi_dstanchors</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The parameter array contains the required element 'objectIdentifier'
|
||||
and the optional element 'attributeSelector'.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-dstofsrcanchor" /></member>
|
||||
<member><xref linkend="function.hwapi-srcanchors" /></member>
|
||||
<member><xref linkend="function.hwapi-dstanchors" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,32 +1,61 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<refentry id="function.hwapi-parents">
|
||||
<refnamediv>
|
||||
<refname>hw_api->parents</refname>
|
||||
<refpurpose>Returns parents of an object</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>hw_api->parents</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>parents</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Retrieves the parents of an object. The parents can be further filtered by
|
||||
specifying an object query. The parameter array
|
||||
contains the required elements 'objectidentifier' and the
|
||||
optional elements 'attributeselector' and 'objectquery'.
|
||||
specifying an object query.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The parameter array contains the required elements 'objectidentifier'
|
||||
and the optional elements 'attributeselector' and 'objectquery'.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
The return value is an array of objects of type
|
||||
<classname>HW_API_Object</classname> or
|
||||
<classname>HW_API_Error</classname>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
See also <function>hwapi_children</function>.
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-children" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,21 +1,32 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-reason-description">
|
||||
<refnamediv>
|
||||
<refname>hw_api_reason->description</refname>
|
||||
<refpurpose>Returns description of reason</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>hw_api_reason->description</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api_reason</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>description</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Returns the description of a reason
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the description, as a string.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,21 +1,32 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.9 $ -->
|
||||
<refentry id="function.hwapi-reason-type">
|
||||
<refnamediv>
|
||||
<refname>hw_api_reason->type</refname>
|
||||
<refpurpose>Returns type of reason</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>HW_API_Reason</type><methodname>hw_api_reason->type</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api_reason</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>HW_API_Reason</type><methodname>type</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Returns the type of a reason.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns an instance of <classname>HW_API_Reason</classname>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,36 +1,74 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.9 $ -->
|
||||
<refentry id="function.hwapi-remove">
|
||||
<refnamediv>
|
||||
<refname>hw_api->remove</refname>
|
||||
<refpurpose>Delete an object</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>hw_api->remove</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>remove</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Removes an object from the specified parent. Collections
|
||||
will be removed recursively. You can pass an optional object query to
|
||||
remove only those objects which match the query. An object will be
|
||||
deleted physically if it is the last instance. The parameter array
|
||||
contains the required elements 'objectidentifier' and 'parentidentifier'.
|
||||
If you want to remove a user or group 'parentidentifier' can be skipped.
|
||||
The optional parameter 'mode' determines how the deletion is performed.
|
||||
In normal mode the object will not be removed physically until all
|
||||
instances are removed. In physical mode all instances of the object will
|
||||
be deleted immediately. In removelinks mode all references
|
||||
to and from the objects will be deleted as well. In nonrecursive the
|
||||
deletion is not performed recursive. Removing a collection which is not
|
||||
empty will cause an error.
|
||||
</para>
|
||||
<para>
|
||||
See also <function>hwapi_move</function>.
|
||||
will be removed recursively.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
You can pass an optional object query to remove only those objects
|
||||
which match the query. An object will be deleted physically if it is
|
||||
the last instance.
|
||||
</para>
|
||||
<para>
|
||||
The parameter array contains the required elements 'objectidentifier'
|
||||
and 'parentidentifier'. If you want to remove a user or group
|
||||
'parentidentifier' can be skipped.
|
||||
</para>
|
||||
<para>
|
||||
The optional parameter 'mode' determines how the deletion is
|
||||
performed. In normal mode the object will not be removed physically
|
||||
until all instances are removed. In physical mode all instances of the
|
||||
object will be deleted immediately. In removelinks mode all references
|
||||
to and from the objects will be deleted as well. In nonrecursive the
|
||||
deletion is not performed recursive. Removing a collection which is
|
||||
not empty will cause an error.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-move" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,84 +1,118 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-replace">
|
||||
<refnamediv>
|
||||
<refname>hw_api->replace</refname>
|
||||
<refpurpose>Replaces an object</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>hw_api->replace</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>replace</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Replaces the attributes and the content of an object.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
Replaces the attributes and the content of an object The parameter array
|
||||
contains the required elements 'objectIdentifier' and 'object' and
|
||||
the optional parameters 'content', 'parameters', 'mode' and
|
||||
'attributeSelector'. 'objectIdentifier' contains the object to be
|
||||
replaced. 'object' contains the new object. 'content' contains the new
|
||||
content. 'parameters' contain extra information for HTML documents.
|
||||
HTML_Language is the letter abbreviation of the language of the title.
|
||||
HTML_Base sets the base attribute of the HTML document. 'mode' can be a
|
||||
combination of the following flags:
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_REPLACE_NORMAL</constant></term>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
The object on the server is replace with the object passed.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_REPLACE_FORCE_VERSION_CONTROL</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_REPLACE_AUTOMATIC_CHECKOUT</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_REPLACE_AUTOMATIC_CHECKIN</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_REPLACE_PLAIN</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_REPLACE_REVERT_IF_NOT_CHANGED</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_REPLACE_KEEP_TIME_MODIFIED</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
</simpara>
|
||||
<para>
|
||||
The parameter array contains the required elements 'objectIdentifier'
|
||||
and 'object' and the optional parameters 'content', 'parameters',
|
||||
'mode' and 'attributeSelector'. 'objectIdentifier' contains the object
|
||||
to be replaced. 'object' contains the new object. 'content' contains
|
||||
the new content. 'parameters' contain extra information for HTML
|
||||
documents. HTML_Language is the letter abbreviation of the language of
|
||||
the title. HTML_Base sets the base attribute of the HTML document.
|
||||
</para>
|
||||
<para>
|
||||
'mode' can be a combination of the following flags:
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_REPLACE_NORMAL</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
The object on the server is replace with the object passed.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_REPLACE_FORCE_VERSION_CONTROL</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_REPLACE_AUTOMATIC_CHECKOUT</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_REPLACE_AUTOMATIC_CHECKIN</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_REPLACE_PLAIN</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_REPLACE_REVERT_IF_NOT_CHANGED</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><constant>HW_API_REPLACE_KEEP_TIME_MODIFIED</constant></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
See also <function>hwapi_insert</function>.
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-insert" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,27 +1,60 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<refentry id="function.hwapi-setcommittedversion">
|
||||
<refnamediv>
|
||||
<refname>hw_api->setcommittedversion</refname>
|
||||
<refpurpose>Commits version other than last version</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>hw_api->setcommittedversion</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>setcommittedversion</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Commits a version of a document. The committed version is the one which is
|
||||
visible to users with read access. By default the last version is the
|
||||
committed version.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
See also <function>hwapi_checkin</function>,
|
||||
<function>hwapi_checkout</function> and <function>hwapi_revert</function>.
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-checkin" /></member>
|
||||
<member><xref linkend="function.hwapi-checkout" /></member>
|
||||
<member><xref linkend="function.hwapi-revert" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,26 +1,58 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-srcanchors">
|
||||
<refnamediv>
|
||||
<refname>hw_api->srcanchors</refname>
|
||||
<refpurpose>Returns a list of all source anchors</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>hw_api->srcanchors</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>srcanchors</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Retrieves all source anchors of an object. The parameter array contains
|
||||
the required element 'objectIdentifier' and the optional elements
|
||||
'attributeSelector' and 'objectQuery'.
|
||||
</para>
|
||||
<para>
|
||||
See also <function>hwapi_dstanchors</function>.
|
||||
Retrieves all source anchors of an object.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The parameter array contains the required element 'objectIdentifier'
|
||||
and the optional elements 'attributeSelector' and 'objectQuery'.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-dstanchors" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,28 +1,61 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-srcsofdst">
|
||||
<refnamediv>
|
||||
<refname>hw_api->srcsofdst</refname>
|
||||
<refpurpose>Returns source of a destination object</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>hw_api->srcsofdst</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>srcsofdst</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Retrieves all the source anchors pointing to the specified destination.
|
||||
The destination object can either be a destination anchor or a whole
|
||||
document. The parameters array contains the required element
|
||||
'objectIdentifier' and the optional element 'attributeSelector' and
|
||||
'objectQuery'. The function returns an array of objects or an error.
|
||||
</para>
|
||||
<para>
|
||||
See also <function>hwapi_dstofsrcanchor</function>.
|
||||
document.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The parameters array contains the required element 'objectIdentifier'
|
||||
and the optional element 'attributeSelector' and 'objectQuery'. The
|
||||
function returns an array of objects or an error.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-dstofsrcanchor" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,31 +1,60 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.9 $ -->
|
||||
<refentry id="function.hwapi-unlock">
|
||||
<refnamediv>
|
||||
<refname>hw_api->unlock</refname>
|
||||
<refpurpose>Unlocks a locked object</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>hw_api->unlock</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>unlock</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
Unlocks a locked object. Only the user who has locked the object and the
|
||||
system user may unlock an object. The parameter array contains the
|
||||
required element 'objectIdentifier' and the optional parameters
|
||||
'mode' and 'objectquery'. The meaning of 'mode' is the same as in
|
||||
function <function>hwapi_lock</function>.
|
||||
system user may unlock an object.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The parameter array contains the required element 'objectIdentifier'
|
||||
and the optional parameters 'mode' and 'objectquery'. The meaning of
|
||||
'mode' is the same as in function <function>hwapi_lock</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns &true; on success or an object of class HW_API_Error.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
See also <function>hwapi_lock</function>.
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-lock" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,21 +1,56 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-user">
|
||||
<refnamediv>
|
||||
<refname>hw_api->user</refname>
|
||||
<refpurpose>Returns the own user object</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>hw_api->user</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>hw_api_object</type><methodname>user</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
See also <function>hwapi_userlist</function>.
|
||||
Returns the own user object.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-userlist" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,21 +1,56 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.hwapi-userlist">
|
||||
<refnamediv>
|
||||
<refname>hw_api->userlist</refname>
|
||||
<refpurpose>Returns a list of all logged in users</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>hw_api->userlist</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<classsynopsis>
|
||||
<ooclass><classname>hw_api</classname></ooclass>
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>userlist</methodname>
|
||||
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</classsynopsis>
|
||||
<para>
|
||||
See also <function>hwapi_user</function>.
|
||||
Returns a list of all logged in users.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>parameter</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><xref linkend="function.hwapi-user" /></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
Loading…
Reference in a new issue