php-doc-en/reference/hw/functions/hw-getobject.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
  <refentry id="function.hw-getobject">
   <refnamediv>
    <refname>hw_GetObject</refname>
    <refpurpose>Object record</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>array</type><methodname>hw_getobject</methodname>
      <methodparam><type>int</type><parameter>connection</parameter></methodparam>
      <methodparam><type>mixed</type><parameter>objectID</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>query</parameter></methodparam>
     </methodsynopsis>
    <para>
     Returns the object record for the object with ID
     <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>
    <para>
     The query string has the following syntax:</para>
    <simpara>
     &lt;expr> ::= "(" &lt;expr> ")" |</simpara>  <simpara>
             "!" &lt;expr> |          /* NOT */</simpara><simpara>
             &lt;expr> "||" &lt;expr> |  /* OR */</simpara><simpara>
             &lt;expr> "&amp;&amp;" &lt;expr> |  /* AND */</simpara><simpara>
             &lt;attribute> &lt;operator> &lt;value></simpara><simpara>

  &lt;attribute> ::= /* any attribute name (Title, Author, DocumentType ...) */</simpara><simpara>

  &lt;operator> ::= "=" |    /* equal */</simpara><simpara>
                 "&lt;" |    /* less than (string compare) */</simpara><simpara>
                 ">" |    /* greater than (string compare) */</simpara><simpara>
                 "~"      /* regular expression matching */</simpara><simpara></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>
    <para>
     See also <function>hw_getandlock</function>,
     and <function>hw_getobjectbyquery</function>.
    </para>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->