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

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.hw-getobjectbyquerycoll" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>hw_GetObjectByQueryColl</refname>
  <refpurpose>Search object in collection</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>hw_getobjectbyquerycoll</methodname>
   <methodparam><type>int</type><parameter>connection</parameter></methodparam>
   <methodparam><type>int</type><parameter>objectID</parameter></methodparam>
   <methodparam><type>string</type><parameter>query</parameter></methodparam>
   <methodparam><type>int</type><parameter>max_hits</parameter></methodparam>
  </methodsynopsis>
  <para>
   Searches for objects in collection with ID <parameter>objectID</parameter>
   and returns an array of object ids.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      <para>
       The connection identifier.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>objectID</parameter></term>
     <listitem>
      <para>
       The collection id.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>query</parameter></term>
     <listitem>
      <para>
       The query will only work with indexed attributes.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>max_hits</parameter></term>
     <listitem>
      <para>
       The maximum number of matches is limited to
       <parameter>max_hits</parameter>. If <parameter>max_hits</parameter> is
       set to -1 the maximum number of matches is unlimited.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an array of object ids.
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>hw_getobjectbyquerycollobj</function></member>
   </simplelist>
  </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:"~/.phpdoc/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
-->