CVS update: php3/doc/functions

Date: Thursday June 10, 1999 @ 5:25 Author: steinm Update of /repository/php3/doc/functions In directory php:/tmp/cvs-serv14804/doc/functions Modified Files: hw.sgml Log Message: - overhaul of Hyperwave module + bug fixes + changes towards php4 + hw_who() now documented + some minor changes to docs Index: php3/doc/functions/hw.sgml diff -u php3/doc/functions/hw.sgml:1.22 php3/doc/functions/hw.sgml:1.23 --- php3/doc/functions/hw.sgml:1.22 Wed Jun 9 12:26:49 1999 +++ php3/doc/functions/hw.sgml Thu Jun 10 05:25:01 1999 @@ -328,6 +328,7 @@ <paramdef>int <parameter>object_to_change</parameter></paramdef> <paramdef>array <parameter>remove</parameter></paramdef> <paramdef>array <parameter>add</parameter></paramdef> + <paramdef>int <parameter>mode</parameter></paramdef> </funcsynopsis> <para> @@ -342,6 +343,13 @@ the value of the attribute to remove is not a string or array. <para> + The last parameter determines if the modification is performed + recursively. 1 means recurive modification. If some of the objects + cannot be modified they will be skiped without notice. + <function>hw_error</function> may not indicate an error though + some of the objects could not be modified. + + <para> The keys of both arrays are the attributes name. The value of each array element can either be an array, a string or anything else. If it is an array @@ -353,10 +361,10 @@ be performed on the attribute. This is neccessary if you want to to add a completely new attribute not just a new value for an existing attribute. If the remove array contained - an empty string for that attribute, the attribute would be tried to + an empty string for that attribute, the attribute would be tried to be removed which would fail since it doesn't exist. The following addition of a new value for that attribute would also fail. Setting the value - for that attribute to e.g. 0 would not even try to remove it since + for that attribute to e.g. 0 would not even try to remove it and the addition will work. <para> @@ -378,7 +386,7 @@ array. If the attribute is the first one with that name to add, set attribute value in the remove array to an integer. <example> - <title>adding a completly new attribute</title> + <title>adding a completely new attribute</title> <programlisting role="php"> // $connect is an existing connection to the Hyperwave server // $objid is the ID of the object to modify @@ -435,8 +443,13 @@ <note><simpara> The 'Name' attribute is somewhat special. In some cases it cannot be complete removed. You will get an error message 'Change of base - attribute'. Therefore you will always have to add a new - Name first and than remove the old one. + attribute' (not clear when this happens). Therefore you will always + have to add a new Name first and than remove the old one. + </simpara></note> + <note><simpara> + You may not suround this function by calls to + <function>hw_getandlock</function> and <function>hw_unlock</function>. + <function>hw_modifyobject</function> does this internally. </simpara></note> <para> Returns TRUE if no error occurs otherwise FALSE. @@ -1609,6 +1622,25 @@ Unlocks a document, so other users regain access. <para> See also <function>hw_GetAndLock</function>. + </refsect1> + </refentry> + + <refentry id="function.hw-who"> + <refnamediv> + <refname>hw_Who</refname> + <refpurpose>List of currently logged in users</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>hw_who</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + </funcsynopsis> + <para> + Returns an array of users currently logged into the Hyperwave server. + Each entry in this array is an array itself containing the elements id, + name, system, onSinceDate, onSinceTime, TotalTime and self. 'self' + is 1 if this entry belongs to the user who initianted the request. </refsect1> </refentry>