mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 22:08:55 +00:00
d34bf80d76
use of entities git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@133657 c90b9560-bf6c-de11-be94-00142212c4b1
89 lines
2.5 KiB
XML
89 lines
2.5 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.3 $ -->
|
|
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
|
|
<refentry id="function.udm-get-res-param">
|
|
<refnamediv>
|
|
<refname>udm_get_res_param</refname>
|
|
<refpurpose>Get mnoGoSearch result parameters</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>udm_get_res_param</methodname>
|
|
<methodparam><type>resource</type><parameter>res</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>param</parameter></methodparam>
|
|
</methodsynopsis>
|
|
|
|
<para>
|
|
<function>udm_get_res_param</function> returns result parameter value on
|
|
success, &false; on error.
|
|
</para>
|
|
|
|
<para>
|
|
<parameter>res</parameter> - a link to result identifier, received after
|
|
call to <function>udm_find</function>.
|
|
</para>
|
|
|
|
<para>
|
|
<parameter>param</parameter> - parameter identifier, may have the following values:
|
|
</para>
|
|
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
UDM_PARAM_NUM_ROWS - number of received found links on the current page. It is equal to
|
|
UDM_PARAM_PAGE_SIZE for all search pages, on the last page - the rest of links.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
UDM_PARAM_FOUND - total number of results matching the query.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
UDM_PARAM_WORDINFO - information on the words found. E.g. search for
|
|
"a good book" will return "a: stopword, good:5637, book: 120"
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
UDM_PARAM_SEARCHTIME - search time in seconds.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
UDM_PARAM_FIRST_DOC - the number of the first document displayed on current page.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
UDM_PARAM_LAST_DOC - the number of the last document displayed on current page.
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
|
|
</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
|
|
-->
|