cvs commit

From: steinm Date: Tue Jul 6 14:32:23 1999 Modified files: phpdoc/functions/hw.sgml Log message: - extended hw_getobject() Index: phpdoc/functions/hw.sgml diff -u phpdoc/functions/hw.sgml:1.4 phpdoc/functions/hw.sgml:1.5 --- phpdoc/functions/hw.sgml:1.4 Sat Jun 19 18:12:06 1999 +++ phpdoc/functions/hw.sgml Tue Jul 6 14:32:22 1999 @@ -853,13 +853,39 @@ <funcsynopsis> <funcdef>array <function>hw_getobject</function></funcdef> <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> + <paramdef>[int|array] <parameter>objectID</parameter></paramdef> + <paramdef>string <parameter>query</parameter></paramdef> </funcsynopsis> <para> Returns the object record for the object with ID - <parameter>objectID</parameter>. + <parameter>objectID</parameter> if the second parameter is an integer. + If the second parameter is an array of integer the function will + return an array of object records. In such a case the last + parameter is also evaluated which is a query string. + <para> + The query string has the following syntax: + <simpara> + &lt;expr> ::= "(" &lt;expr> ")" | <simpara> + "!" &lt;expr> | /* NOT */<simpara> + &lt;expr> "||" &lt;expr> | /* OR */<simpara> + &lt;expr> "&amp;&amp;" &lt;expr> | /* AND */<simpara> + &lt;attribute> &lt;operator> &lt;value><simpara> + + &lt;attribute> ::= /* any attribute name (Title, Author, DocumentType ...) */<simpara> + + &lt;operator> ::= "=" | /* equal */<simpara> + "&lt;" | /* less than (string compare) */<simpara> + ">" | /* greater than (string compare) */<simpara> + "~" /* regular expression matching */<simpara> + <para> + The query allows to further select certain objects from the list + of given objects. Unlike the other + query functions, this query may use not indexed attributes. How many + object records are returned depends on the query and if access to + the object is allowed. <para> - See also <function>hw_GetAndLock</function>. + See also <function>hw_GetAndLock</function>, + <function>hw_GetObjectByQuery</function>. </refsect1> </refentry> @@ -958,6 +984,8 @@ <parameter>max_hits</parameter>. If <parameter>max_hits</parameter> is set to -1 the maximum number of matches is unlimited. <para> + The query will only work with indexed attributes. + <para> See also <function>hw_GetObjectByQueryObj</function>. </refsect1> </refentry> @@ -981,6 +1009,8 @@ <parameter>max_hits</parameter>. If <parameter>max_hits</parameter> is set to -1 the maximum number of matches is unlimited. <para> + The query will only work with indexed attributes. + <para> See also <function>hw_GetObjectByQuery</function>. </refsect1> </refentry> @@ -1007,6 +1037,8 @@ If <parameter>max_hits</parameter> is set to -1 the maximum number of matches is unlimited. <para> + The query will only work with indexed attributes. + <para> See also <function>hw_GetObjectByQueryCollObj</function>. </refsect1> </refentry> @@ -1032,6 +1064,8 @@ <parameter>max_hits</parameter>. If <parameter>max_hits</parameter> is set to -1 the maximum number of matches is unlimited. + <para> + The query will only work with indexed attributes. <para> See also <function>hw_GetObjectByQueryColl</function>. </refsect1>