php-doc-en/reference/mnogosearch/functions/udm-get-res-field.xml
Hartmut Holzgraefe 5b9fc29465 revision tags added
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@78496 c90b9560-bf6c-de11-be94-00142212c4b1
2002-04-17 06:45:35 +00:00

133 lines
3.6 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
<refentry id="function.udm-get-res-field">
<refnamediv>
<refname>udm_get_res_field</refname>
<refpurpose>Fetch mnoGoSearch result field</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>udm_get_res_field</methodname>
<methodparam><type>int</type><parameter>res</parameter></methodparam>
<methodparam><type>int</type><parameter>row</parameter></methodparam>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
<function>udm_get_res_field</function> returns result field 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>row</parameter> - the number of the link on the current page.
May have values from 0 to
<parameter>UDM_PARAM_NUM_ROWS-1</parameter>.
</para>
<para>
<parameter>field</parameter> - field identifier, may have the following values:
</para>
<itemizedlist>
<listitem>
<simpara>
UDM_FIELD_URL - document URL field
</simpara>
</listitem>
<listitem>
<simpara>
UDM_FIELD_CONTENT - document Content-type field (for example, text/html).
</simpara>
</listitem>
<listitem>
<simpara>
UDM_FIELD_CATEGORY - document category field. Use
<function>udm_cat_path</function> to get full path to current category
from the categories tree root. (This parameter is available only in PHP
4.0.6 or later).
</simpara>
</listitem>
<listitem>
<simpara>
UDM_FIELD_TITLE - document title field.
</simpara>
</listitem>
<listitem>
<simpara>
UDM_FIELD_KEYWORDS - document keywords field (from META KEYWORDS tag).
</simpara>
</listitem>
<listitem>
<simpara>
UDM_FIELD_DESC - document description field (from META DESCRIPTION tag).
</simpara>
</listitem>
<listitem>
<simpara>
UDM_FIELD_TEXT - document body text (the first couple of lines to give an
idea of what the document is about).
</simpara>
</listitem>
<listitem>
<simpara>
UDM_FIELD_SIZE - document size.
</simpara>
</listitem>
<listitem>
<simpara>
UDM_FIELD_URLID - unique URL ID of the link.
</simpara>
</listitem>
<listitem>
<simpara>
UDM_FIELD_RATING - page rating (as calculated by mnoGoSearch).
</simpara>
</listitem>
<listitem>
<simpara>
UDM_FIELD_MODIFIED - last-modified field in unixtime format.
</simpara>
</listitem>
<listitem>
<simpara>
UDM_FIELD_ORDER - the number of the current document in set of found documents.
</simpara>
</listitem>
<listitem>
<simpara>
UDM_FIELD_CRC - document CRC.
</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
-->