mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 05:48:57 +00:00
50 lines
1.8 KiB
XML
50 lines
1.8 KiB
XML
|
<?xml version='1.0' encoding='iso-8859-1' ?>
|
||
|
|
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
||
|
|
<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>find</methodname>
|
||
|
|
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
||
|
|
</methodsynopsis>
|
||
|
|
<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
|
||
|
|
object query. They are sorted by their importance. The second search
|
||
|
|
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', 'lanugages' and 'attributeselector'. In case of
|
||
|
|
an incremental search the optional parameters 'startIndex',
|
||
|
|
numberOfObjectsToGet' and 'exactMatchUnit' can be passed.
|
||
|
|
</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
|
||
|
|
-->
|